org.hypergraphdb
Enum HGRandomAccessResult.GotoResult

java.lang.Object
  java.lang.Enum<HGRandomAccessResult.GotoResult>
      org.hypergraphdb.HGRandomAccessResult.GotoResult

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HGRandomAccessResult.GotoResult>

Enclosing interface:

HGRandomAccessResult<ValueType>

public static enum HGRandomAccessResult.GotoResult
extends java.lang.Enum<HGRandomAccessResult.GotoResult>

Enumerates the possible results of a call to the goTo in a HGRandomAccessResult.

Author:

Borislav Iordanov

Enum Constant Summary

close
Indicates that the element was not found, but the cursor was positioned to the next element greater than the element sought for.

found
Indicates that the element was found and the cursor is positioned on that element.

nothing
Indicates that the element was not found and the cursor has NOT changed position.

Method Summary

static HGRandomAccessResult.GotoResult	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HGRandomAccessResult.GotoResult[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

found

public static final HGRandomAccessResult.GotoResult found

Indicates that the element was found and the cursor is positioned on that element.

nothing

public static final HGRandomAccessResult.GotoResult nothing

Indicates that the element was not found and the cursor has NOT changed position.

close

public static final HGRandomAccessResult.GotoResult close

Indicates that the element was not found, but the cursor was positioned to the next element greater than the element sought for.

Method Detail

values

public static final HGRandomAccessResult.GotoResult[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(HGRandomAccessResult.GotoResult c : HGRandomAccessResult.GotoResult.values())
        System.out.println(c);

Returns:

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

valueOf

public static HGRandomAccessResult.GotoResult 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