Package com.apple.foundationdb.record
Enum CursorStreamingMode
- java.lang.Object
-
- java.lang.Enum<CursorStreamingMode>
-
- com.apple.foundationdb.record.CursorStreamingMode
-
- All Implemented Interfaces:
Serializable
,Comparable<CursorStreamingMode>
@API(EXPERIMENTAL) public enum CursorStreamingMode extends Enum<CursorStreamingMode>
The streaming mode to use when openingRecordCursor
s.- See Also:
ScanProperties.getCursorStreamingMode()
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ITERATOR
The client will process records one-at-a-time.WANT_ALL
The client will load all records immediately, such as withRecordCursor.asList()
.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static CursorStreamingMode
valueOf(String name)
Returns the enum constant of this type with the specified name.static CursorStreamingMode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
ITERATOR
public static final CursorStreamingMode ITERATOR
The client will process records one-at-a-time.
-
WANT_ALL
public static final CursorStreamingMode WANT_ALL
The client will load all records immediately, such as withRecordCursor.asList()
.
-
-
Method Detail
-
values
public static CursorStreamingMode[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (CursorStreamingMode c : CursorStreamingMode.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static CursorStreamingMode valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
-