Package org.codehaus.staxmate.in
Enum CursorBase.State
- All Implemented Interfaces:
Serializable
,Comparable<CursorBase.State>
,java.lang.constant.Constable
- Enclosing class:
CursorBase
State constants are used for keeping track of state of individual
cursors.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionActive means that cursor's data is valid and can be accessed; plus it can be advanced as well.Closed cursors are ones that do not point to accessible data, nor can be advanced any further.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 means that the cursor has been constructed, but hasn't yet been advanced. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic CursorBase.State
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 Details
-
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
Active means that cursor's data is valid and can be accessed; plus it can be advanced as well. -
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
Closed cursors are ones that do not point to accessible data, nor can be advanced any further.
-
-
Constructor Details
-
State
private State()
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 nameNullPointerException
- if the argument is null
-