aries-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] tmaret commented on a change in pull request #12: Fix/extend documentation for the request builder
Date Sat, 05 Jan 2019 10:10:19 GMT
tmaret commented on a change in pull request #12: Fix/extend documentation for the request
builder
URL: https://github.com/apache/aries-journaled-events/pull/12#discussion_r245473336
 
 

 ##########
 File path: org.apache.aries.events.api/src/main/java/org/apache/aries/events/api/SubscribeRequest.java
 ##########
 @@ -35,15 +38,36 @@ private SubscribeRequest(String topic, Consumer<Received> callback)
{
         this.callback = callback;
     }
 
+    /**
+     * Build a subscription request for the given topic and {@code Consumer} callback.
+     *
+     * @param topic to consume from
+     * @param callback to be invoked for each message consumed
+     * @return a new subscription request
+     */
     public static SubscribeRequest to(String topic, Consumer<Received> callback) {
         return new SubscribeRequest(topic, callback);
     }
-    
+
+    /**
+     * Set the {@code Position} position to start consuming from.
+     *
+     * @param position in the topic to start consuming from
+     * @return the updated subscribe request
+     */
     public SubscribeRequest startAt(Position position) {
         this.position = position;
         return this;
     }
-    
+
+    /**
+     * Set the earliest or latest position to start consuming from
+     * when the position is {@code null} or not valid. By default,
+     * seek is set to {@link Seek#earliest}.
 
 Review comment:
   Thanks for spotting this. Updated the PR.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

Mime
View raw message