com.apple.foundationdb.record

Class RecordCursorEndContinuation

java.lang.Object

com.apple.foundationdb.record.RecordCursorEndContinuation

All Implemented Interfaces:

RecordCursorContinuation

@API(value=INTERNAL)
public class RecordCursorEndContinuation
extends Object
implements RecordCursorContinuation

A concrete continuation representing that a RecordCursor has returned all of the records that it ever will. This is the structured continuation equivalent of a null byte array continuation.

Field Summary

Fields

Modifier and Type	Field and Description
static RecordCursorContinuation	END

Method Summary

Modifier and Type	Method and Description
boolean	isEnd() Return whether this continuation is an "end continuation", i.e., represents that the iteration has reached its end and would not produce more results even if restarted.
byte[]	toBytes() Serialize this continuation to a byte array.

Methods inherited from class java.lang.Object

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

Field Detail

END

public static final RecordCursorContinuation END

Method Detail

toBytes

@Nullable
public byte[] toBytes()

Description copied from interface: RecordCursorContinuation

Serialize this continuation to a byte array. This method must always return the same array contents (but not necessarily the same array). If RecordCursorContinuation.isEnd() returns true, then toBytes() must return null.

Specified by:

toBytes in interface RecordCursorContinuation

Returns:

a (possibly null) byte array containing a binary serialization of this continuation

isEnd

public boolean isEnd()

Description copied from interface: RecordCursorContinuation

Return whether this continuation is an "end continuation", i.e., represents that the iteration has reached its end and would not produce more results even if restarted. If isEnd() returns true, then RecordCursorContinuation.toBytes() must return null.

Specified by:

isEnd in interface RecordCursorContinuation

Returns:

whether this continuation represents the end of a cursor's iteration