com.apple.foundationdb.record.cursors

Enum MapWhileCursor.StopContinuation

java.lang.Object

java.lang.Enum<MapWhileCursor.StopContinuation>

com.apple.foundationdb.record.cursors.MapWhileCursor.StopContinuation

All Implemented Interfaces:

Serializable, Comparable<MapWhileCursor.StopContinuation>

Enclosing class:

MapWhileCursor<T,V>

public static enum MapWhileCursor.StopContinuation
extends Enum<MapWhileCursor.StopContinuation>

What to return for MapWhileCursor.getContinuation() after stopping.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AFTER Return the continuation following the record that stopped the cursor.
BEFORE Return the continuation before the record that stopped the cursor.
NONE Return null.

Method Summary

Modifier and Type	Method and Description
static MapWhileCursor.StopContinuation	valueOf(String name) Returns the enum constant of this type with the specified name.
static MapWhileCursor.StopContinuation[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final MapWhileCursor.StopContinuation NONE

Return null.

AFTER

public static final MapWhileCursor.StopContinuation AFTER

Return the continuation following the record that stopped the cursor.

BEFORE

public static final MapWhileCursor.StopContinuation BEFORE

Return the continuation before the record that stopped the cursor. That is, arrange for the cursor to continue by repeating that record.

Method Detail

values

public static MapWhileCursor.StopContinuation[] 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 (MapWhileCursor.StopContinuation c : MapWhileCursor.StopContinuation.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MapWhileCursor.StopContinuation 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 name

NullPointerException - if the argument is null