Package org.bson

Enum Class AbstractBsonReader.State

java.lang.Object

java.lang.Enum<AbstractBsonReader.State>

org.bson.AbstractBsonReader.State

All Implemented Interfaces:

Serializable, Comparable<AbstractBsonReader.State>, java.lang.constant.Constable

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.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

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

Modifier and Type	Method	Description
static AbstractBsonReader.State	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AbstractBsonReader.State[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 Details

values

public static AbstractBsonReader.State[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static AbstractBsonReader.State valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null