org.bson

Enum BsonContextType

java.lang.Object

java.lang.Enum<BsonContextType>

org.bson.BsonContextType

All Implemented Interfaces:

Serializable, Comparable<BsonContextType>

public enum BsonContextType
extends Enum<BsonContextType>

Used by BsonReader and BsonWriter implementations to represent the current context.

Since:

3.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARRAY A BSON array.
DOCUMENT A (possibly embedded) BSON document.
JAVASCRIPT_WITH_SCOPE A JAVASCRIPT_WITH_SCOPE BSON value.
SCOPE_DOCUMENT The scope document of a JAVASCRIPT_WITH_SCOPE BSON value.
TOP_LEVEL The top level of a BSON document.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TOP_LEVEL

public static final BsonContextType TOP_LEVEL

The top level of a BSON document.

DOCUMENT

public static final BsonContextType DOCUMENT

A (possibly embedded) BSON document.

ARRAY

public static final BsonContextType ARRAY

A BSON array.

JAVASCRIPT_WITH_SCOPE

public static final BsonContextType JAVASCRIPT_WITH_SCOPE

A JAVASCRIPT_WITH_SCOPE BSON value.

SCOPE_DOCUMENT

public static final BsonContextType SCOPE_DOCUMENT

The scope document of a JAVASCRIPT_WITH_SCOPE BSON value.

Method Detail

values

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

Returns:

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

valueOf

public static BsonContextType 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 name

NullPointerException - if the argument is null