RecordCursorStartContinuation (fdb-record-layer-core 2.10.164.0 API)

java.lang.Object
- com.apple.foundationdb.record.RecordCursorStartContinuation

All Implemented Interfaces:

RecordCursorContinuation
```
@API(INTERNAL)
public class RecordCursorStartContinuation
extends Object
implements RecordCursorContinuation
```
A continuation representing the start of a cursor's execution. This continuation is not perfectly well behaved, for historical reasons. Specifically, its binary serialization is null, which is the same as the binary serialization of RecordCursorEndContinuation. As a result, the two are distinguishable only through the result of isEnd(). Because a start continuation is only used internally and a continuation can be obtained only with a RecordCursorResult---at which point the cursor is no longer at its "start"---there is no ambiguity to an external API consumer. However, it remains a potential pitfall.

Field Summary

Fields
Modifier and Type Field Description

static RecordCursorContinuation START

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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - START
```
public static final RecordCursorContinuation START
```
- Method Detail
  - 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
  - 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