org.apache.directory.shared.ldap.cursor
Enum CursorStateEnum

java.lang.Object
  extended by java.lang.Enum<CursorStateEnum>
      extended by org.apache.directory.shared.ldap.cursor.CursorStateEnum
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<CursorStateEnum>

public enum CursorStateEnum
extends java.lang.Enum<CursorStateEnum>

An enumeration to represent the various states of a Cursor.

Version:
$Rev$, $Date$
Author:
Apache Directory Project

Enum Constant Summary
AFTER_INNER
          the Cursor is positioned just after an element but not on any element
AFTER_LAST
          the Cursor is positioned just after the last element
BEFORE_FIRST
          the Cursor is positioned just before the first element
BEFORE_INNER
          the Cursor is positioned just before an element but not on any element
CLOSED
          the Cursor is closed and not operations can be performed on it
JUST_OPENED
          the Cursor has been created and so has not been positioned yet
ON_FIRST
          the Cursor is positioned on the first element
ON_INNER
          the Cursor is positioned on an element
ON_LAST
          the Cursor is positioned on the last element
 
Method Summary
static CursorStateEnum valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static CursorStateEnum[] 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

JUST_OPENED

public static final CursorStateEnum JUST_OPENED
the Cursor has been created and so has not been positioned yet


BEFORE_FIRST

public static final CursorStateEnum BEFORE_FIRST
the Cursor is positioned just before the first element


AFTER_LAST

public static final CursorStateEnum AFTER_LAST
the Cursor is positioned just after the last element


BEFORE_INNER

public static final CursorStateEnum BEFORE_INNER
the Cursor is positioned just before an element but not on any element


AFTER_INNER

public static final CursorStateEnum AFTER_INNER
the Cursor is positioned just after an element but not on any element


ON_FIRST

public static final CursorStateEnum ON_FIRST
the Cursor is positioned on the first element


ON_LAST

public static final CursorStateEnum ON_LAST
the Cursor is positioned on the last element


ON_INNER

public static final CursorStateEnum ON_INNER
the Cursor is positioned on an element


CLOSED

public static final CursorStateEnum CLOSED
the Cursor is closed and not operations can be performed on it

Method Detail

values

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

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

valueOf

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


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.