de.undercouch.bson4jackson
Enum BsonParser.Feature

java.lang.Object
  java.lang.Enum<BsonParser.Feature>
      de.undercouch.bson4jackson.BsonParser.Feature

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BsonParser.Feature>

Enclosing class:

BsonParser

public static enum BsonParser.Feature
extends java.lang.Enum<BsonParser.Feature>

Defines toggable features

Enum Constant Summary

HONOR_DOCUMENT_LENGTH
Honors the document length field when parsing, useful for when reading from streams that may contain other content after the document that will be read by something else.

Method Summary

int	getMask()
static BsonParser.Feature	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BsonParser.Feature[]	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

HONOR_DOCUMENT_LENGTH

public static final BsonParser.Feature HONOR_DOCUMENT_LENGTH

Honors the document length field when parsing, useful for when reading from streams that may contain other content after the document that will be read by something else.

Method Detail

values

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

Returns:

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

valueOf

public static BsonParser.Feature 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

java.lang.NullPointerException - if the argument is null

getMask

public int getMask()

Returns:

the bit mask that identifies this feature