Package com.apple.foundationdb.record.provider.foundationdb

Class KeyValueCursor.Builder

java.lang.Object

com.apple.foundationdb.record.provider.foundationdb.KeyValueCursor.Builder

Enclosing class:

KeyValueCursor

@API(MAINTAINED)
public static class KeyValueCursor.Builder
extends Object

A builder for KeyValueCursor.

 KeyValueCursor.Builder.withSubspace(subspace)
                     .setContext(context)
                     .setRange(TupleRange.ALL)
                     .setContinuation(null)
                     .setScanProperties(ScanProperties.FORWARD_SCAN)
                     .build()
 

Method Summary

Modifier and Type	Method	Description
KeyValueCursor	build()
KeyValueCursor.Builder	setContext(FDBRecordContext context)
KeyValueCursor.Builder	setContinuation(byte[] continuation)
KeyValueCursor.Builder	setHigh(byte[] highBytes, EndpointType highEndpoint)
KeyValueCursor.Builder	setHigh(Tuple high, EndpointType highEndpoint)
KeyValueCursor.Builder	setLow(byte[] lowBytes, EndpointType lowEndpoint)
KeyValueCursor.Builder	setLow(Tuple low, EndpointType lowEndpoint)
KeyValueCursor.Builder	setRange(KeyRange range)
KeyValueCursor.Builder	setRange(TupleRange range)
KeyValueCursor.Builder	setScanProperties(ScanProperties scanProperties)
static KeyValueCursor.Builder	withSubspace(Subspace subspace)

Methods inherited from class java.lang.Object

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

Method Detail

withSubspace

public static KeyValueCursor.Builder withSubspace(@Nonnull
                                                  Subspace subspace)

build

public KeyValueCursor build()
                     throws RecordCoreException

Throws:

RecordCoreException

setContext

public KeyValueCursor.Builder setContext(FDBRecordContext context)

setContinuation

public KeyValueCursor.Builder setContinuation(@Nullable
                                              byte[] continuation)

setScanProperties

public KeyValueCursor.Builder setScanProperties(@Nonnull
                                                ScanProperties scanProperties)

setRange

public KeyValueCursor.Builder setRange(@Nonnull
                                       KeyRange range)

setRange

public KeyValueCursor.Builder setRange(@Nonnull
                                       TupleRange range)

setLow

public KeyValueCursor.Builder setLow(@Nullable
                                     Tuple low,
                                     @Nonnull
                                     EndpointType lowEndpoint)

setLow

public KeyValueCursor.Builder setLow(@Nonnull
                                     byte[] lowBytes,
                                     @Nonnull
                                     EndpointType lowEndpoint)

setHigh

public KeyValueCursor.Builder setHigh(@Nullable
                                      Tuple high,
                                      @Nonnull
                                      EndpointType highEndpoint)

setHigh

public KeyValueCursor.Builder setHigh(@Nonnull
                                      byte[] highBytes,
                                      @Nonnull
                                      EndpointType highEndpoint)