com.sleepycat.je.dbi

Enum SearchMode

java.lang.Object

java.lang.Enum<SearchMode>

com.sleepycat.je.dbi.SearchMode

All Implemented Interfaces:

Serializable, Comparable<SearchMode>

public enum SearchMode
extends Enum<SearchMode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY_RANGE
BOTH
BOTH_RANGE
SET
SET_RANGE

Method Summary

Modifier and Type	Method and Description
boolean	isDataSearch() Returns true when the data value is included in the search, i.e., for BOTH and BOTH_RANGE.
boolean	isExactSearch() Returns true when the key or key/data search is exact, i.e., for SET and BOTH.
String	toString()
static SearchMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static SearchMode[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SET

public static final SearchMode SET

BOTH

public static final SearchMode BOTH

SET_RANGE

public static final SearchMode SET_RANGE

BOTH_RANGE

public static final SearchMode BOTH_RANGE

ANY_RANGE

public static final SearchMode ANY_RANGE

Method Detail

values

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

Returns:

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

valueOf

public static SearchMode 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

isExactSearch

public final boolean isExactSearch()

Returns true when the key or key/data search is exact, i.e., for SET and BOTH.

isDataSearch

public final boolean isDataSearch()

Returns true when the data value is included in the search, i.e., for BOTH and BOTH_RANGE. Note that this returns false for ANY_RANGE because the data value is only included in the search for dup DBs.

toString

public String toString()

Overrides:

toString in class Enum<SearchMode>