Skip to content

Commit e497c66

Browse files
committed
Fixup for #51: Javadoc update for "no request body".
1 parent dc67141 commit e497c66

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

nakadi-producer/src/main/java/org/zalando/nakadiproducer/snapshots/SnapshotEventGenerator.java

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,13 @@ public interface SnapshotEventGenerator {
4040
*
4141
* @param filter
4242
* a filter for the snapshot generation mechanism. This value is
43-
* simply passed through from the REST endpoint (or other
44-
* triggering mechanism), so implementations can interpret it in
45-
* whatever way you want (even ignore it). All calls for one
46-
* snapshot generation will receive the same string.
43+
* simply passed through from the request body of the REST
44+
* endpoint (or from any other triggering mechanism). If there
45+
* was no request body, this will be {@code null}.
46+
*
47+
* Implementors can interpret it in whatever way they want (even
48+
* ignore it). All calls for one snapshot generation will receive
49+
* the same string.
4750
*
4851
* @return list of elements (wrapped in Snapshot objects) ordered by their
4952
* ID.

0 commit comments

Comments
 (0)