com.persistit

Enum Key.Direction

java.lang.Object

java.lang.Enum<Key.Direction>

com.persistit.Key.Direction

All Implemented Interfaces:

Serializable, Comparable<Key.Direction>

Enclosing class:

Key

public static enum Key.Direction
extends Enum<Key.Direction>

Enumeration of possible qualifiers for the traverse and remove methods. Values include EQ, GT, GTEQ, LT and LTEQ.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EQ Indicates for traverse that only the specified key, if it exists, is to be returned.
GT Indicates for traverse that the next larger key is to be returned.
GTEQ Indicates for traverse that the specified key, if it exists, or else the next larger key is to be returned.
LT Indicates for traverse that the next smaller key is to be returned.
LTEQ Indicates for traverse that the specified key, if it exists, or else the next smaller key is to be returned.

Method Summary

Modifier and Type	Method and Description
static Key.Direction	valueOf(String name) Returns the enum constant of this type with the specified name.
static Key.Direction[]	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

EQ

public static final Key.Direction EQ

Indicates for traverse that only the specified key, if it exists, is to be returned. Indicates for remove that only the specified key is to be removed.

LT

public static final Key.Direction LT

Indicates for traverse that the next smaller key is to be returned. Not valid for remove.

LTEQ

public static final Key.Direction LTEQ

Indicates for traverse that the specified key, if it exists, or else the next smaller key is to be returned. Not valid for remove.

GT

public static final Key.Direction GT

Indicates for traverse that the next larger key is to be returned. Indicates for remove that a range of keys following but not including the specified key is to be removed.

GTEQ

public static final Key.Direction GTEQ

Indicates for traverse that the specified key, if it exists, or else the next larger key is to be returned. Indicates for remove that a range of keys including and following the specified key is to be removed.

Method Detail

values

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

Returns:

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

valueOf

public static Key.Direction 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