com.basho.riak.client.api

Class StreamableRiakCommand.StreamableResponse<T,S>

java.lang.Object

com.basho.riak.client.api.StreamableRiakCommand.StreamableResponse<T,S>

All Implemented Interfaces:

Iterable<T>

Direct Known Subclasses:

ListBuckets.Response, ListKeys.Response, MapReduce.Response, SecondaryIndexQuery.Response

Enclosing class:

StreamableRiakCommand<R extends StreamableRiakCommand.StreamableResponse,I,CoreR,CoreI>

public abstract static class StreamableRiakCommand.StreamableResponse<T,S>
extends Object
implements Iterable<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected ChunkedResponseIterator<T,?,S>	chunkedResponseIterator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StreamableResponse() Constructor for not streamable response.
protected	StreamableResponse(ChunkedResponseIterator<T,?,S> chunkedResponseIterator) Constructor for streamable response

Method Summary

Modifier and Type	Method and Description
boolean	isStreaming() Whether the results are to be streamed back.
Iterator<T>	iterator() Get an iterator over the result data.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

chunkedResponseIterator

protected ChunkedResponseIterator<T,?,S> chunkedResponseIterator

Constructor Detail

StreamableResponse

protected StreamableResponse(ChunkedResponseIterator<T,?,S> chunkedResponseIterator)

Constructor for streamable response

Parameters:

chunkedResponseIterator -

StreamableResponse

protected StreamableResponse()

Constructor for not streamable response.

Method Detail

isStreaming

public boolean isStreaming()

Whether the results are to be streamed back. If true, results will appear in this class's iterator. If false, they will appear in the original result collection.

Returns:

true if the results are to be streamed.

iterator

public Iterator<T> iterator()

Get an iterator over the result data. If using the streaming API, this method will block and wait for more data if none is immediately available. It is also advisable to check Thread.isInterrupted() in environments where thread interrupts must be obeyed.

Specified by:

iterator in interface Iterable<T>

Returns:

an iterator over the result data.