Skip to content

Commit bc3eb86

Browse files
committed
Polish the java doc in Stream
1 parent ad2ca1b commit bc3eb86

File tree

1 file changed

+3
-2
lines changed
  • openmessaging-api/src/main/java/io/openmessaging/consumer

1 file changed

+3
-2
lines changed

openmessaging-api/src/main/java/io/openmessaging/consumer/Stream.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,14 +52,14 @@ public interface Stream extends ServiceLifecycle {
5252
/**
5353
* Creates a {@code MessageIterator} from the begin position of current stream.
5454
*
55-
* @return the first offset, return -1 if the partition has no message.
55+
* @return a message iterator at the begin position.
5656
*/
5757
MessageIterator begin();
5858

5959
/**
6060
* Creates a {@code MessageIterator} from the end position of current stream.
6161
*
62-
* @return the last offset, return 0 if the iterator is first created.
62+
* @return a message iterator at the begin position.
6363
*/
6464
MessageIterator end();
6565

@@ -74,6 +74,7 @@ public interface Stream extends ServiceLifecycle {
7474
* is later than the last message's store timestamp in this stream.
7575
*
7676
* @param timestamp the specified timestamp
77+
* @return a message iterator at the specified timestamp
7778
*/
7879
MessageIterator seekByTime(long timestamp);
7980
}

0 commit comments

Comments
 (0)