Package org.codehaus.staxmate.in
Enum CursorBase.State
- java.lang.Object
-
- java.lang.Enum<CursorBase.State>
-
- org.codehaus.staxmate.in.CursorBase.State
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<CursorBase.State>
- Enclosing class:
- CursorBase
public static enum CursorBase.State extends java.lang.Enum<CursorBase.State>
State constants are used for keeping track of state of individual cursors.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ACTIVE
Active means that cursor's data is valid and can be accessed; plus it can be advanced as well.CLOSED
Closed cursors are ones that do not point to accessible data, nor can be advanced any further.HAS_CHILD
Status that indicates that although cursor would be active, there is a child cursor active which means that this cursor can not be used to access data: only the innermost child cursor can.INITIAL
Initial means that the cursor has been constructed, but hasn't yet been advanced.
-
Constructor Summary
Constructors Modifier Constructor Description private
State()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static CursorBase.State
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static CursorBase.State[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
INITIAL
public static final CursorBase.State INITIAL
Initial means that the cursor has been constructed, but hasn't yet been advanced. No data can be accessed yet, but the cursor can be advanced.
-
ACTIVE
public static final CursorBase.State ACTIVE
Active means that cursor's data is valid and can be accessed; plus it can be advanced as well.
-
HAS_CHILD
public static final CursorBase.State HAS_CHILD
Status that indicates that although cursor would be active, there is a child cursor active which means that this cursor can not be used to access data: only the innermost child cursor can. It can still be advanced, however.
-
CLOSED
public static final CursorBase.State CLOSED
Closed cursors are ones that do not point to accessible data, nor can be advanced any further.
-
-
Method Detail
-
values
public static CursorBase.State[] 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 (CursorBase.State c : CursorBase.State.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static CursorBase.State 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 namejava.lang.NullPointerException
- if the argument is null
-
-