org.codehaus.staxmate.in
Enum SMInputCursor.State

java.lang.Object
  java.lang.Enum<SMInputCursor.State>
      org.codehaus.staxmate.in.SMInputCursor.State

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SMInputCursor.State>

Enclosing class:

SMInputCursor

protected static enum SMInputCursor.State
extends java.lang.Enum<SMInputCursor.State>

Enum Constant Summary

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.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INITIAL

public static final SMInputCursor.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 SMInputCursor.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 SMInputCursor.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 SMInputCursor.State CLOSED

Closed cursors are ones that do not point to accessible data, nor can be advanced any further.

Method Detail

values

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

Returns:

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

valueOf

public static SMInputCursor.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 name