com.basho.riak.client.raw.http

Class KeySource

java.lang.Object

com.basho.riak.client.raw.http.KeySource

All Implemented Interfaces:

StreamingOperation<String>, Iterable<String>, Iterator<String>

public class KeySource
extends Object
implements StreamingOperation<String>

Wraps the stream of keys from BucketResponse.getBucketInfo.getKeys in an iterator, handles closing the underlying http stream when finished.

Author:

russell

Constructor Summary

Constructors

Constructor and Description
KeySource(BucketResponse bucketResponse) Create a Key Source from an http.BucketResponse in response to RiakClient.streamBucket(String) request.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Cancels the operation and cleans up the underlying network connection
List<String>	getAll() Retrieve all elements from the operation and return them in a List
String	getContinuation() Get the continuation value
boolean	hasContinuation() If this is a paginated operation, a "continuation" value may be available
boolean	hasNext()
Iterator<String>	iterator()
String	next()
void	remove() This is a read only stream of keys, calling this results in UnsupportedOperationException

Methods inherited from class java.lang.Object

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

Constructor Detail

KeySource

public KeySource(BucketResponse bucketResponse)

Create a Key Source from an http.BucketResponse in response to RiakClient.streamBucket(String) request. The bucket response contains a stream which you must close if you do not iterate over the entire set.

Parameters:

bucketResponse - the BucketResponse with a List of keys.

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<String>

next

public String next()

Specified by:

next in interface Iterator<String>

cancel

public void cancel()

Description copied from interface: StreamingOperation

Cancels the operation and cleans up the underlying network connection

Specified by:

cancel in interface StreamingOperation<String>

remove

public void remove()

This is a read only stream of keys, calling this results in UnsupportedOperationException

Specified by:

remove in interface Iterator<String>

See Also:

Iterator.remove()

getAll

public List<String> getAll()

Description copied from interface: StreamingOperation

Retrieve all elements from the operation and return them in a List

Specified by:

getAll in interface StreamingOperation<String>

Returns:

a List containing all elements resulting from the operation

iterator

public Iterator<String> iterator()

Specified by:

iterator in interface Iterable<String>

hasContinuation

public boolean hasContinuation()

Description copied from interface: StreamingOperation

If this is a paginated operation, a "continuation" value may be available

Specified by:

hasContinuation in interface StreamingOperation<String>

getContinuation

public String getContinuation()

Description copied from interface: StreamingOperation

Get the continuation value

Specified by:

getContinuation in interface StreamingOperation<String>

Returns:

A string representation of the continuation value or null if not present