Package com.sleepycat.je

Enum ScanFilter.ScanResult

java.lang.Object

java.lang.Enum<ScanFilter.ScanResult>

com.sleepycat.je.ScanFilter.ScanResult

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ScanFilter.ScanResult>

Enclosing interface:

ScanFilter

public static enum ScanFilter.ScanResult
extends java.lang.Enum<ScanFilter.ScanResult>

Returned by ScanFilter.checkKey(byte[]).

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXCLUDE	Indicates the key should not be included, but the scan should continue.
EXCLUDE_STOP	Indicates the key should not be included, and the scan should stop.
INCLUDE	Indicates the key should be included and the scan should continue.
INCLUDE_STOP	Indicates the key should be included and the scan should stop.

Method Summary

Modifier and Type	Method	Description
boolean	getInclude()	Returns true for INCLUDE and INCLUDE_STOP.
boolean	getStop()	Returns true for INCLUDE_STOP and EXCLUDE_STOP.
static ScanFilter.ScanResult	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ScanFilter.ScanResult[]	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

INCLUDE

public static final ScanFilter.ScanResult INCLUDE

Indicates the key should be included and the scan should continue.

EXCLUDE

public static final ScanFilter.ScanResult EXCLUDE

Indicates the key should not be included, but the scan should continue.

INCLUDE_STOP

public static final ScanFilter.ScanResult INCLUDE_STOP

Indicates the key should be included and the scan should stop.

EXCLUDE_STOP

public static final ScanFilter.ScanResult EXCLUDE_STOP

Indicates the key should not be included, and the scan should stop.

Method Detail

values

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

Returns:

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

valueOf

public static ScanFilter.ScanResult valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getInclude

public boolean getInclude()

Returns true for INCLUDE and INCLUDE_STOP.

getStop

public boolean getStop()

Returns true for INCLUDE_STOP and EXCLUDE_STOP.