com.basho.riak.client.api.commands

Class ChunkedResponseIterator<FinalT,ChunkT extends Iterable<CoreT>,CoreT>

java.lang.Object

com.basho.riak.client.api.commands.ChunkedResponseIterator<FinalT,ChunkT,CoreT>

Type Parameters:

FinalT - The final converted type that this class exposes as part of its iterator.

ChunkT - The type of the response chunks, contains an Iterable<CoreT>

CoreT - The raw response type, will get converted to FinalT.

All Implemented Interfaces:

Iterator<FinalT>

public class ChunkedResponseIterator<FinalT,ChunkT extends Iterable<CoreT>,CoreT>
extends Object
implements Iterator<FinalT>

Transforms a stream of response chunks to a Iterable of response items. When iterating over this class's Iterator this class will lazily walk through the response chunks's iterators and convert the items. It will also wait for more response chunks if none are available. Since this class polls for new "streaming" data, it is advisable to check Thread.isInterrupted() while using this class's Iterator in environments where thread interrupts must be obeyed.

Since:

2.1.0

Author:

Alex Moore , Sergey Galkin

Field Summary

Fields

Modifier and Type	Field and Description
protected Iterator<CoreT>	currentIterator

Constructor Summary

Constructors

Constructor and Description
ChunkedResponseIterator(StreamingRiakFuture<ChunkT,?> coreFuture, int pollTimeout, Function<CoreT,FinalT> createNextFn, Function<ChunkT,Iterator<CoreT>> getNextIteratorFn)
ChunkedResponseIterator(StreamingRiakFuture<ChunkT,?> coreFuture, int pollTimeout, Function<CoreT,FinalT> createNextFn, Function<ChunkT,Iterator<CoreT>> getNextIteratorFn, Function<ChunkT,BinaryValue> getContinuationFn)

Method Summary

Modifier and Type	Method and Description
BinaryValue	getContinuation() Returns the current value of the continuation.
boolean	hasContinuation() Returns whether this response contains a continuation.
boolean	hasNext() Returns true if the iteration has more elements.
FinalT	next() Returns the next element in the iteration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Field Detail

currentIterator

protected Iterator<CoreT> currentIterator

Constructor Detail

ChunkedResponseIterator

public ChunkedResponseIterator(StreamingRiakFuture<ChunkT,?> coreFuture,
                               int pollTimeout,
                               Function<CoreT,FinalT> createNextFn,
                               Function<ChunkT,Iterator<CoreT>> getNextIteratorFn)

ChunkedResponseIterator

public ChunkedResponseIterator(StreamingRiakFuture<ChunkT,?> coreFuture,
                               int pollTimeout,
                               Function<CoreT,FinalT> createNextFn,
                               Function<ChunkT,Iterator<CoreT>> getNextIteratorFn,
                               Function<ChunkT,BinaryValue> getContinuationFn)

Method Detail

hasNext

public boolean hasNext()

Returns true if the iteration has more elements. (In other words, returns true if next() would return an element rather than throwing an exception.) This method will block and wait for more data if none is immediately available. Riak Java Client Note: Since this class polls for new "streaming" data, it is advisable to check Thread.isInterrupted() in environments where thread interrupts must be obeyed.

Specified by:

hasNext in interface Iterator<FinalT>

Returns:

true if the iteration has more elements

hasContinuation

public boolean hasContinuation()

Returns whether this response contains a continuation. Only run this once the operation is complete, otherwise it will return true as it's

Returns:

Whether this response has a continuation.

getContinuation

public BinaryValue getContinuation()

Returns the current value of the continuation. Only run this once the operation is complete, or else you will get a null value.

Returns:

The continuation value (if any).

next

public FinalT next()

Returns the next element in the iteration. This method will block and wait for more data if none is immediately available. Riak Java Client Note: Since this class polls for new "streaming" data, it is advisable to check Thread.isInterrupted() in environments where thread interrupts must be obeyed.

Specified by:

next in interface Iterator<FinalT>

Returns:

the next element in the iteration

Throws:

NoSuchElementException - if the iteration has no more elements