ElementType (mongodb-async-driver 2.0.1 API)

java.lang.Object
- java.lang.Enum<ElementType>
- - com.allanbank.mongodb.bson.ElementType

All Implemented Interfaces:

Serializable, Comparable<ElementType>
```
public enum ElementType
extends Enum<ElementType>
```
Enumeration of the possible BSON types.

API Notice:

This enumeration is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2011-2013, Allanbank Consulting, Inc., All Rights Reserved

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ARRAY` The BSON array type.
`BINARY` The BSON binary type.
`BOOLEAN` The BSON boolean type.
`DB_POINTER` Deprecated. See BSON specification.
`DOCUMENT` The BSON document type.
`DOUBLE` The BSON double type.
`INTEGER` The BSON 32-bit singed integer type.
`JAVA_SCRIPT` The BSON JavaScript type.
`JAVA_SCRIPT_WITH_SCOPE` The BSON JavaScript w/ scope type.
`LONG` The BSON 32-bit singed integer (long) type.
`MAX_KEY` The BSON MAX key type.
`MIN_KEY` The BSON MIN key type.
`MONGO_TIMESTAMP` The BSON MongoDB Timestamp type.
`NULL` The BSON null type.
`OBJECT_ID` The BSON ObjectIdElement type.
`REGEX` The BSON regular expression type.
`STRING` The BSON string type.
`SYMBOL` The BSON Symbol type.
`UTC_TIMESTAMP` The BSON UTC Timestamp type.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compare(ElementType rhs)` Similar to `Enum.compareTo(E)` but instead of comparing on the ordinal value compares the values based on the MongoDB sort order.
`byte`	`getToken()` Returns the token for the BSON type.
`static ElementType`	`valueOf(byte token)` Returns the ElementType with the provided token or `null` if it is not found.
`static ElementType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ElementType[]`	`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
  - ARRAY
```
public static final ElementType ARRAY
```
    The BSON array type.
  - BINARY
```
public static final ElementType BINARY
```
    The BSON binary type.
  - BOOLEAN
```
public static final ElementType BOOLEAN
```
    The BSON boolean type.
  - DB_POINTER
```
@Deprecated
public static final ElementType DB_POINTER
```
    Deprecated. See BSON specification.
    
    The BSON DB Pointer type.
  - DOCUMENT
```
public static final ElementType DOCUMENT
```
    The BSON document type.
  - DOUBLE
```
public static final ElementType DOUBLE
```
    The BSON double type.
  - INTEGER
```
public static final ElementType INTEGER
```
    The BSON 32-bit singed integer type.
  - JAVA_SCRIPT
```
public static final ElementType JAVA_SCRIPT
```
    The BSON JavaScript type.
  - JAVA_SCRIPT_WITH_SCOPE
```
public static final ElementType JAVA_SCRIPT_WITH_SCOPE
```
    The BSON JavaScript w/ scope type.
  - LONG
```
public static final ElementType LONG
```
    The BSON 32-bit singed integer (long) type.
  - MAX_KEY
```
public static final ElementType MAX_KEY
```
    The BSON MAX key type.
  - MIN_KEY
```
public static final ElementType MIN_KEY
```
    The BSON MIN key type.
  - MONGO_TIMESTAMP
```
public static final ElementType MONGO_TIMESTAMP
```
    The BSON MongoDB Timestamp type.
  - NULL
```
public static final ElementType NULL
```
    The BSON null type.
  - OBJECT_ID
```
public static final ElementType OBJECT_ID
```
    The BSON ObjectIdElement type.
  - REGEX
```
public static final ElementType REGEX
```
    The BSON regular expression type.
  - STRING
```
public static final ElementType STRING
```
    The BSON string type.
  - SYMBOL
```
public static final ElementType SYMBOL
```
    The BSON Symbol type.
  - UTC_TIMESTAMP
```
public static final ElementType UTC_TIMESTAMP
```
    The BSON UTC Timestamp type.
- Method Detail
  - values
```
public static ElementType[] 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 (ElementType c : ElementType.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ElementType 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
  - valueOf
```
public static ElementType valueOf(byte token)
```
    Returns the ElementType with the provided token or null if it is not found.
    
    Parameters:
    token - The BSON type token to find the ElementType for.
    
    Returns:
    The ElementType with the provided token or null if it is not found.
  - compare
```
public int compare(ElementType rhs)
```
    Similar to Enum.compareTo(E) but instead of comparing on the ordinal value compares the values based on the MongoDB sort order.
    
    Parameters:
    rhs - The right-hand-side of the ordering.
    
    Returns:
    A negative value if this ElementType is less than the rhs, zero if they are equal, and a positive value if it is greater than the rhs.
  - getToken
```
public byte getToken()
```
    Returns the token for the BSON type.
    
    Returns:
    The token for the BSON type.

Enum ElementType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ARRAY

BINARY

BOOLEAN

DB_POINTER

DOCUMENT

DOUBLE

INTEGER

JAVA_SCRIPT

JAVA_SCRIPT_WITH_SCOPE

LONG

MAX_KEY

MIN_KEY

MONGO_TIMESTAMP

NULL

OBJECT_ID

REGEX

STRING

SYMBOL

UTC_TIMESTAMP

Method Detail

values

valueOf

valueOf

compare

getToken