StreamingIterator (openmessaging-api 0.3.1-alpha 0.3.1-alpha API)

```
public interface StreamingIterator
```
A StreamingIterator is provided by Stream and is used to retrieve messages a specified stream like a read-only iterator.

Since:

OMS 1.0.0

Version:

OMS 1.0.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`KeyValue`	`attributes()` Returns the attributes of this `StreamingIterator` instance.
`boolean`	`hasNext()` Returns `true` if this iterator has more messages when traversing the iterator in the forward direction.
`boolean`	`hasPrevious()` Returns `true` if this partition iterator has more messages when traversing the iterator in the reverse direction.
`Message`	`next()` Returns the next message in the iteration and advances the offset position.
`String`	`nextPosition()` Returns the position of the message that would be returned by a subsequent call to `next()`.
`Message`	`previous()` Returns the previous message in the iteration and moves the offset position backwards.
`String`	`previousPosition()` Returns the position of the message that would be returned by a subsequent call to `previous()`.

- Method Detail
  - attributes
```
KeyValue attributes()
```
    Returns the attributes of this StreamingIterator instance.
    There are some standard attributes defined by OMS for Stream:
    - OMSBuiltinKeys.OPERATION_TIMEOUT, the default timeout period for operations of Stream.
    Returns:
    
    the attributes
  - hasNext
```
boolean hasNext()
```
    Returns true if this iterator has more messages when traversing the iterator in the forward direction.
    
    Returns:
    
    true if the iterator has more messages
  - next
```
Message next()
```
    Returns the next message in the iteration and advances the offset position.
    This method may be called repeatedly to iterate through the iteration, or intermixed with calls to previous() to go back and forth.
    
    Returns:
    
    the next message in the list
    
    Throws:
    
    OMSRuntimeException - if the iteration has no more message, or the the consumer fails to receive the next message
  - hasPrevious
```
boolean hasPrevious()
```
    Returns true if this partition iterator has more messages when traversing the iterator in the reverse direction.
    
    Returns:
    
    true if the partition iterator has more messages when traversing the iterator in the reverse direction
  - previous
```
Message previous()
```
    Returns the previous message in the iteration and moves the offset position backwards.
    This method may be called repeatedly to iterate through the iteration backwards, or intermixed with calls to next() to go back and forth.
    
    Returns:
    
    the previous message in the list
    
    Throws:
    
    OMSRuntimeException - if the iteration has no previous message, or the the consumer fails to receive the previous message
  - nextPosition
```
String nextPosition()
```
    Returns the position of the message that would be returned by a subsequent call to next().
    
    Returns:
    
    the position of the next message
    
    Throws:
    
    OMSRuntimeException - if the iteration has no next message
  - previousPosition
```
String previousPosition()
```
    Returns the position of the message that would be returned by a subsequent call to previous().
    
    Returns:
    
    the position of the previous message
    
    Throws:
    
    OMSRuntimeException - if the iteration has no previous message

Interface StreamingIterator

Method Summary

Method Detail

attributes

hasNext

next

hasPrevious

previous

nextPosition

previousPosition