Package org.bson
Enum AbstractBsonReader.State
- java.lang.Object
-
- java.lang.Enum<AbstractBsonReader.State>
-
- org.bson.AbstractBsonReader.State
-
- All Implemented Interfaces:
Serializable
,Comparable<AbstractBsonReader.State>
- Enclosing class:
- AbstractBsonReader
public static enum AbstractBsonReader.State extends Enum<AbstractBsonReader.State>
The state of a reader. Indicates where in a document the reader is.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CLOSED
The reader is closed.DONE
The reader has finished reading a document.END_OF_ARRAY
The reader is positioned at the end of an array.END_OF_DOCUMENT
The reader is positioned at the end of a document.INITIAL
The initial state.NAME
The reader is positioned at the name of an element.SCOPE_DOCUMENT
The reader is positioned at a scope document.TYPE
The reader is positioned at the type of an element or value.VALUE
The reader is positioned at a value.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static AbstractBsonReader.State
valueOf(String name)
Returns the enum constant of this type with the specified name.static AbstractBsonReader.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 AbstractBsonReader.State INITIAL
The initial state.
-
TYPE
public static final AbstractBsonReader.State TYPE
The reader is positioned at the type of an element or value.
-
NAME
public static final AbstractBsonReader.State NAME
The reader is positioned at the name of an element.
-
VALUE
public static final AbstractBsonReader.State VALUE
The reader is positioned at a value.
-
SCOPE_DOCUMENT
public static final AbstractBsonReader.State SCOPE_DOCUMENT
The reader is positioned at a scope document.
-
END_OF_DOCUMENT
public static final AbstractBsonReader.State END_OF_DOCUMENT
The reader is positioned at the end of a document.
-
END_OF_ARRAY
public static final AbstractBsonReader.State END_OF_ARRAY
The reader is positioned at the end of an array.
-
DONE
public static final AbstractBsonReader.State DONE
The reader has finished reading a document.
-
CLOSED
public static final AbstractBsonReader.State CLOSED
The reader is closed.
-
-
Method Detail
-
values
public static AbstractBsonReader.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 (AbstractBsonReader.State c : AbstractBsonReader.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 AbstractBsonReader.State valueOf(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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
-