Package org.apache.hadoop.hbase.regionserver

Enum Class ScannerContext.NextState

java.lang.Object

java.lang.Enum<ScannerContext.NextState>

org.apache.hadoop.hbase.regionserver.ScannerContext.NextState

All Implemented Interfaces:

Serializable, Comparable<ScannerContext.NextState>, Constable

Enclosing class:

ScannerContext

public static enum ScannerContext.NextState
extends Enum<ScannerContext.NextState>

The possible states a scanner may be in following a call to InternalScanner.next(List)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BATCH_LIMIT_REACHED
MORE_VALUES
NO_MORE_VALUES
SIZE_LIMIT_REACHED
SIZE_LIMIT_REACHED_MID_ROW	Special case of size limit reached to indicate that the size limit was reached in the middle of a row and thus a partial results was formed
TIME_LIMIT_REACHED
TIME_LIMIT_REACHED_MID_ROW	Special case of time limit reached to indicate that the time limit was reached in the middle of a row and thus a partial results was formed

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	limitReached
private final boolean	moreValues

Constructor Summary

Constructors

Modifier	Constructor	Description
private	NextState(boolean moreValues, boolean limitReached)

Method Summary

Modifier and Type	Method	Description
boolean	hasMoreValues()
static boolean	hasMoreValues(ScannerContext.NextState state)
static boolean	isValidState(ScannerContext.NextState state)
boolean	limitReached()	Returns true when the state indicates that a limit has been reached and scan should stop
static ScannerContext.NextState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ScannerContext.NextState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MORE_VALUES

public static final ScannerContext.NextState MORE_VALUES

NO_MORE_VALUES

public static final ScannerContext.NextState NO_MORE_VALUES

SIZE_LIMIT_REACHED

public static final ScannerContext.NextState SIZE_LIMIT_REACHED

SIZE_LIMIT_REACHED_MID_ROW

public static final ScannerContext.NextState SIZE_LIMIT_REACHED_MID_ROW

Special case of size limit reached to indicate that the size limit was reached in the middle of a row and thus a partial results was formed

TIME_LIMIT_REACHED

public static final ScannerContext.NextState TIME_LIMIT_REACHED

TIME_LIMIT_REACHED_MID_ROW

public static final ScannerContext.NextState TIME_LIMIT_REACHED_MID_ROW

Special case of time limit reached to indicate that the time limit was reached in the middle of a row and thus a partial results was formed

BATCH_LIMIT_REACHED

public static final ScannerContext.NextState BATCH_LIMIT_REACHED

Field Details

moreValues

private final boolean moreValues

limitReached

private final boolean limitReached

Constructor Details

NextState

private NextState(boolean moreValues,
 boolean limitReached)

Method Details

values

public static ScannerContext.NextState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ScannerContext.NextState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

hasMoreValues

public boolean hasMoreValues()

Returns:

true when the state indicates that more values may follow those that have been returned

limitReached

public boolean limitReached()

Returns true when the state indicates that a limit has been reached and scan should stop

isValidState

public static boolean isValidState(ScannerContext.NextState state)

hasMoreValues

public static boolean hasMoreValues(ScannerContext.NextState state)