Package com.apple.foundationdb.record
Class RecordCursorEndContinuation
- java.lang.Object
-
- com.apple.foundationdb.record.RecordCursorEndContinuation
-
- All Implemented Interfaces:
RecordCursorContinuation
@API(INTERNAL) public class RecordCursorEndContinuation extends Object implements RecordCursorContinuation
A concrete continuation representing that aRecordCursor
has returned all of the records that it ever will. This is the structured continuation equivalent of anull
byte array continuation.
-
-
Field Summary
Fields Modifier and Type Field Description static RecordCursorContinuation
END
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.
-
-
-
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). IfRecordCursorContinuation.isEnd()
returnstrue
, thentoBytes()
must returnnull
.- Specified by:
toBytes
in interfaceRecordCursorContinuation
- 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. IfisEnd()
returnstrue
, thenRecordCursorContinuation.toBytes()
must returnnull
.- Specified by:
isEnd
in interfaceRecordCursorContinuation
- Returns:
- whether this continuation represents the end of a cursor's iteration
-
-