BsonDocument (mongo-java-driver 3.0.0-beta1 API)

java.lang.Object
- org.bson.BsonValue
- - org.bson.BsonDocument

All Implemented Interfaces:

Serializable, Map<String,BsonValue>

Direct Known Subclasses:

BsonDocumentWrapper, RawBsonDocument
```
public class BsonDocument
extends BsonValue
implements Map<String,BsonValue>, Serializable
```
A type-safe container for a BSON document.

Since:

3.0

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description
`BsonDocument()` Construct an empty document.
`BsonDocument(List<BsonElement> bsonElements)` Construct a new instance with the given list `BsonElement`, none of which may be null.
`BsonDocument(String key, BsonValue value)` Construct a new instance with a single key value pair

Method Summary

Methods
Modifier and Type	Method and Description
`BsonDocument`	`append(String key, BsonValue value)` Put the given key and value into this document, and return the document.
`void`	`clear()`
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`Set<Map.Entry<String,BsonValue>>`	`entrySet()`
`boolean`	`equals(Object o)`
`BsonValue`	`get(Object key)`
`BsonValue`	`get(Object key, BsonValue defaultValue)` If the document does not contain the given key, return the given default value.
`BsonArray`	`getArray(Object key)` Gets the value of the key if it is a BsonArray, or throws if not.
`BsonArray`	`getArray(Object key, BsonArray defaultValue)` If the document does not contain the given key, return the given default value.
`BsonBinary`	`getBinary(Object key)` Gets the value of the key if it is a Binary, or throws if not.
`BsonBinary`	`getBinary(Object key, BsonBinary defaultValue)` If the document does not contain the given key, return the given default value.
`BsonBoolean`	`getBoolean(Object key)` Gets the value of the key if it is a BsonBoolean, or throws if not.
`BsonBoolean`	`getBoolean(Object key, BsonBoolean defaultValue)` If the document does not contain the given key, return the given default value.
`BsonType`	`getBsonType()` Gets the BSON type of this value.
`BsonDateTime`	`getDateTime(Object key)` Gets the value of the key if it is a BsonDateTime, or throws if not.
`BsonDateTime`	`getDateTime(Object key, BsonDateTime defaultValue)` If the document does not contain the given key, return the given default value.
`BsonDocument`	`getDocument(Object key)` Gets the value of the key if it is a BsonDocument, or throws if not.
`BsonDocument`	`getDocument(Object key, BsonDocument defaultValue)` If the document does not contain the given key, return the given default value.
`BsonDouble`	`getDouble(Object key)` Gets the value of the key if it is a BsonDouble, or throws if not.
`BsonDouble`	`getDouble(Object key, BsonDouble defaultValue)` If the document does not contain the given key, return the given default value.
`BsonInt32`	`getInt32(Object key)` Gets the value of the key if it is a BsonInt32, or throws if not.
`BsonInt32`	`getInt32(Object key, BsonInt32 defaultValue)` If the document does not contain the given key, return the given default value.
`BsonInt64`	`getInt64(Object key)` Gets the value of the key if it is a BsonInt64, or throws if not.
`BsonInt64`	`getInt64(Object key, BsonInt64 defaultValue)` Gets the value of the key if it is a BsonInt64, or throws if not.
`BsonNumber`	`getNumber(Object key)` Gets the value of the key if it is a BsonNumber, or throws if not.
`BsonNumber`	`getNumber(Object key, BsonNumber defaultValue)` If the document does not contain the given key, return the given default value.
`BsonObjectId`	`getObjectId(Object key)` Gets the value of the key if it is a BsonObjectId, or throws if not.
`BsonObjectId`	`getObjectId(Object key, BsonObjectId defaultValue)` If the document does not contain the given key, return the given default value.
`BsonRegularExpression`	`getRegularExpression(Object key)` Gets the value of the key if it is a RegularExpression, or throws if not.
`BsonRegularExpression`	`getRegularExpression(Object key, BsonRegularExpression defaultValue)` If the document does not contain the given key, return the given default value.
`BsonString`	`getString(Object key)` Gets the value of the key if it is a BsonString, or throws if not.
`BsonString`	`getString(Object key, BsonString defaultValue)` If the document does not contain the given key, return the given default value.
`BsonTimestamp`	`getTimestamp(Object key)` Gets the value of the key if it is a Timestamp, or throws if not.
`BsonTimestamp`	`getTimestamp(Object key, BsonTimestamp defaultValue)` If the document does not contain the given key, return the given default value.
`int`	`hashCode()`
`boolean`	`isArray(Object key)` Returns true if the value of the key is a BsonArray, returns false if the document does not contain the key.
`boolean`	`isBinary(Object key)` Returns true if the value of the key is a Binary, returns false if the document does not contain the key.
`boolean`	`isBoolean(Object key)` Returns true if the value of the key is a BsonBoolean, returns false if the document does not contain the key.
`boolean`	`isDateTime(Object key)` Returns true if the value of the key is a BsonDateTime, returns false if the document does not contain the key.
`boolean`	`isDocument(Object key)` Returns true if the value of the key is a BsonDocument, returns false if the document does not contain the key.
`boolean`	`isDouble(Object key)` Returns true if the value of the key is a BsonDouble, returns false if the document does not contain the key.
`boolean`	`isEmpty()`
`boolean`	`isInt32(Object key)` Returns true if the value of the key is a BsonInt32, returns false if the document does not contain the key.
`boolean`	`isInt64(Object key)` Returns true if the value of the key is a BsonInt64, returns false if the document does not contain the key.
`boolean`	`isNull(Object key)` Returns true if the value of the key is a BsonNull, returns false if the document does not contain the key.
`boolean`	`isNumber(Object key)` Returns true if the value of the key is a BsonNumber, returns false if the document does not contain the key.
`boolean`	`isObjectId(Object key)` Returns true if the value of the key is a ObjectId, returns false if the document does not contain the key.
`boolean`	`isString(Object key)` Returns true if the value of the key is a BsonString, returns false if the document does not contain the key.
`boolean`	`isTimestamp(Object key)` Returns true if the value of the key is a Timestamp, returns false if the document does not contain the key.
`Set<String>`	`keySet()`
`BsonValue`	`put(String key, BsonValue value)`
`void`	`putAll(Map<? extends String,? extends BsonValue> m)`
`BsonValue`	`remove(Object key)`
`int`	`size()`
`String`	`toJson()` Gets a JSON representation of this document
`String`	`toString()`
`Collection<BsonValue>`	`values()`

Methods inherited from class org.bson.BsonValue
asArray, asBinary, asBoolean, asDateTime, asDBPointer, asDocument, asDouble, asInt32, asInt64, asJavaScript, asJavaScriptWithScope, asNumber, asObjectId, asRegularExpression, asString, asSymbol, asTimestamp, isArray, isBinary, isBoolean, isDateTime, isDBPointer, isDocument, isDouble, isInt32, isInt64, isJavaScript, isJavaScriptWithScope, isNull, isNumber, isObjectId, isRegularExpression, isString, isSymbol, isTimestamp

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BsonDocument
```
public BsonDocument(List<BsonElement> bsonElements)
```
    Construct a new instance with the given list BsonElement, none of which may be null.
    
    Parameters:
    bsonElements - a list of BsonElement
  - BsonDocument
```
public BsonDocument(String key,
            BsonValue value)
```
    Construct a new instance with a single key value pair
    
    Parameters:
    key - the key
    value - the value
  - BsonDocument
```
public BsonDocument()
```
    Construct an empty document.
- Method Detail
  - getBsonType
```
public BsonType getBsonType()
```
    Description copied from class: BsonValue
    
    Gets the BSON type of this value.
    
    Specified by:
    
    getBsonType in class BsonValue
    
    Returns:
    the BSON type, which may not be null (but may be BSONType.NULL)
  - size
```
public int size()
```
    Specified by:
    
    size in interface Map<String,BsonValue>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Map<String,BsonValue>
  - containsKey
```
public boolean containsKey(Object key)
```
    Specified by:
    
    containsKey in interface Map<String,BsonValue>
  - containsValue
```
public boolean containsValue(Object value)
```
    Specified by:
    
    containsValue in interface Map<String,BsonValue>
  - get
```
public BsonValue get(Object key)
```
    Specified by:
    
    get in interface Map<String,BsonValue>
  - getDocument
```
public BsonDocument getDocument(Object key)
```
    Gets the value of the key if it is a BsonDocument, or throws if not.
    
    Parameters:
    key - the key
    
    Returns:
    the value of the key as a BsonDocument
    
    Throws:
    
    BsonInvalidOperationException - if the document does not contain the key or the value is not a BsonDocument
  - getArray
```
public BsonArray getArray(Object key)
```
    Gets the value of the key if it is a BsonArray, or throws if not.
    
    Parameters:
    key - the key
    
    Returns:
    the value of the key as a BsonArray
    
    Throws:
    
    BsonInvalidOperationException - if the document does not contain the key or the value is not of the expected type
  - getNumber
```
public BsonNumber getNumber(Object key)
```
    Gets the value of the key if it is a BsonNumber, or throws if not.
    
    Parameters:
    key - the key
    
    Returns:
    the value of the key as a BsonNumber
    
    Throws:
    
    BsonInvalidOperationException - if the document does not contain the key or the value is not of the expected type
  - getInt32
```
public BsonInt32 getInt32(Object key)
```
    Gets the value of the key if it is a BsonInt32, or throws if not.
    
    Parameters:
    key - the key
    
    Returns:
    the value of the key as a BsonInt32
    
    Throws:
    
    BsonInvalidOperationException - if the document does not contain the key or the value is not of the expected type
  - getInt64
```
public BsonInt64 getInt64(Object key)
```
    Gets the value of the key if it is a BsonInt64, or throws if not.
    
    Parameters:
    key - the key
    
    Returns:
    the value of the key as a BsonInt64
    
    Throws:
    
    BsonInvalidOperationException - if the document does not contain the key or the value is not of the expected type
  - getDouble
```
public BsonDouble getDouble(Object key)
```
    Gets the value of the key if it is a BsonDouble, or throws if not.
    
    Parameters:
    key - the key
    
    Returns:
    the value of the key as a BsonDouble
    
    Throws:
    
    BsonInvalidOperationException - if the document does not contain the key or the value is not of the expected type
  - getBoolean
```
public BsonBoolean getBoolean(Object key)
```
    Gets the value of the key if it is a BsonBoolean, or throws if not.
    
    Parameters:
    key - the key
    
    Returns:
    the value of the key as a BsonBoolean
    
    Throws:
    
    BsonInvalidOperationException - if the document does not contain the key or the value is not of the expected type
  - getString
```
public BsonString getString(Object key)
```
    Gets the value of the key if it is a BsonString, or throws if not.
    
    Parameters:
    key - the key
    
    Returns:
    the value of the key as a BsonString
    
    Throws:
    
    BsonInvalidOperationException - if the document does not contain the key or the value is not of the expected type
  - getDateTime
```
public BsonDateTime getDateTime(Object key)
```
    Gets the value of the key if it is a BsonDateTime, or throws if not.
    
    Parameters:
    key - the key
    
    Returns:
    the value of the key as a BsonDateTime
    
    Throws:
    
    BsonInvalidOperationException - if the document does not contain the key or the value is not of the expected type
  - getTimestamp
```
public BsonTimestamp getTimestamp(Object key)
```
    Gets the value of the key if it is a Timestamp, or throws if not.
    
    Parameters:
    key - the key
    
    Returns:
    the value of the key as a Timestamp
    
    Throws:
    
    BsonInvalidOperationException - if the document does not contain the key or the value is not of the expected type
  - getObjectId
```
public BsonObjectId getObjectId(Object key)
```
    Gets the value of the key if it is a BsonObjectId, or throws if not.
    
    Parameters:
    key - the key
    
    Returns:
    the value of the key as a BsonObjectId
    
    Throws:
    
    BsonInvalidOperationException - if the document does not contain the key or the value is not of the expected type
  - getRegularExpression
```
public BsonRegularExpression getRegularExpression(Object key)
```
    Gets the value of the key if it is a RegularExpression, or throws if not.
    
    Parameters:
    key - the key
    
    Returns:
    the value of the key as a RegularExpression
    
    Throws:
    
    BsonInvalidOperationException - if the document does not contain the key or the value is not of the expected type
  - getBinary
```
public BsonBinary getBinary(Object key)
```
    Gets the value of the key if it is a Binary, or throws if not.
    
    Parameters:
    key - the key
    
    Returns:
    the value of the key as a Binary
    
    Throws:
    
    BsonInvalidOperationException - if the document does not contain the key or the value is not of the expected type
  - isNull
```
public boolean isNull(Object key)
```
    Returns true if the value of the key is a BsonNull, returns false if the document does not contain the key.
    
    Parameters:
    key - the key
    
    Returns:
    true if the value of the key is a BsonNull, returns false if the document does not contain the key.
  - isDocument
```
public boolean isDocument(Object key)
```
    Returns true if the value of the key is a BsonDocument, returns false if the document does not contain the key.
    
    Parameters:
    key - the key
    
    Returns:
    true if the value of the key is a BsonDocument, returns false if the document does not contain the key.
  - isArray
```
public boolean isArray(Object key)
```
    Returns true if the value of the key is a BsonArray, returns false if the document does not contain the key.
    
    Parameters:
    key - the key
    
    Returns:
    true if the value of the key is a BsonArray, returns false if the document does not contain the key.
  - isNumber
```
public boolean isNumber(Object key)
```
    Returns true if the value of the key is a BsonNumber, returns false if the document does not contain the key.
    
    Parameters:
    key - the key
    
    Returns:
    true if the value of the key is a BsonNumber, returns false if the document does not contain the key.
  - isInt32
```
public boolean isInt32(Object key)
```
    Returns true if the value of the key is a BsonInt32, returns false if the document does not contain the key.
    
    Parameters:
    key - the key
    
    Returns:
    true if the value of the key is a BsonInt32, returns false if the document does not contain the key.
  - isInt64
```
public boolean isInt64(Object key)
```
    Returns true if the value of the key is a BsonInt64, returns false if the document does not contain the key.
    
    Parameters:
    key - the key
    
    Returns:
    true if the value of the key is a BsonInt64, returns false if the document does not contain the key.
  - isDouble
```
public boolean isDouble(Object key)
```
    Returns true if the value of the key is a BsonDouble, returns false if the document does not contain the key.
    
    Parameters:
    key - the key
    
    Returns:
    true if the value of the key is a BsonDouble, returns false if the document does not contain the key.
  - isBoolean
```
public boolean isBoolean(Object key)
```
    Returns true if the value of the key is a BsonBoolean, returns false if the document does not contain the key.
    
    Parameters:
    key - the key
    
    Returns:
    true if the value of the key is a BsonBoolean, returns false if the document does not contain the key.
  - isString
```
public boolean isString(Object key)
```
    Returns true if the value of the key is a BsonString, returns false if the document does not contain the key.
    
    Parameters:
    key - the key
    
    Returns:
    true if the value of the key is a BsonString, returns false if the document does not contain the key.
  - isDateTime
```
public boolean isDateTime(Object key)
```
    Returns true if the value of the key is a BsonDateTime, returns false if the document does not contain the key.
    
    Parameters:
    key - the key
    
    Returns:
    true if the value of the key is a BsonDateTime, returns false if the document does not contain the key.
  - isTimestamp
```
public boolean isTimestamp(Object key)
```
    Returns true if the value of the key is a Timestamp, returns false if the document does not contain the key.
    
    Parameters:
    key - the key
    
    Returns:
    true if the value of the key is a Timestamp, returns false if the document does not contain the key.
  - isObjectId
```
public boolean isObjectId(Object key)
```
    Returns true if the value of the key is a ObjectId, returns false if the document does not contain the key.
    
    Parameters:
    key - the key
    
    Returns:
    true if the value of the key is a ObjectId, returns false if the document does not contain the key.
  - isBinary
```
public boolean isBinary(Object key)
```
    Returns true if the value of the key is a Binary, returns false if the document does not contain the key.
    
    Parameters:
    key - the key
    
    Returns:
    true if the value of the key is a Binary, returns false if the document does not contain the key.
  - get
```
public BsonValue get(Object key,
            BsonValue defaultValue)
```
    If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key.
    
    Parameters:
    key - the key
    defaultValue - the default value
    
    Returns:
    the value of the key as a BsonValue
  - getDocument
```
public BsonDocument getDocument(Object key,
                       BsonDocument defaultValue)
```
    If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a BsonDocument.
    
    Parameters:
    key - the key
    defaultValue - the default value
    
    Returns:
    the value of the key as a BsonDocument
    
    Throws:
    
    BsonInvalidOperationException - if the document contains the key but the value is not of the expected type
  - getArray
```
public BsonArray getArray(Object key,
                 BsonArray defaultValue)
```
    If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a BsonArray.
    
    Parameters:
    key - the key
    defaultValue - the default value
    
    Returns:
    the value of the key as a BsonArray
    
    Throws:
    
    BsonInvalidOperationException - if the document contains the key but the value is not of the expected type
  - getNumber
```
public BsonNumber getNumber(Object key,
                   BsonNumber defaultValue)
```
    If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a BsonNumber.
    
    Parameters:
    key - the key
    defaultValue - the default value
    
    Returns:
    the value of the key as a BsonNumber
    
    Throws:
    
    BsonInvalidOperationException - if the document contains the key but the value is not of the expected type
  - getInt32
```
public BsonInt32 getInt32(Object key,
                 BsonInt32 defaultValue)
```
    If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a BsonInt32.
    
    Parameters:
    key - the key
    defaultValue - the default value
    
    Returns:
    the value of the key as a BsonInt32
    
    Throws:
    
    BsonInvalidOperationException - if the document contains the key but the value is not of the expected type
  - getInt64
```
public BsonInt64 getInt64(Object key,
                 BsonInt64 defaultValue)
```
    Gets the value of the key if it is a BsonInt64, or throws if not.
    
    Parameters:
    key - the key
    defaultValue - the default value
    
    Returns:
    the value of the key as a BsonInt64
    
    Throws:
    
    BsonInvalidOperationException - if the document contains the key but the value is not of the expected type
  - getDouble
```
public BsonDouble getDouble(Object key,
                   BsonDouble defaultValue)
```
    If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a BsonDouble.
    
    Parameters:
    key - the key
    defaultValue - the default value
    
    Returns:
    the value of the key as a BsonDouble
    
    Throws:
    
    BsonInvalidOperationException - if the document contains the key but the value is not of the expected type
  - getBoolean
```
public BsonBoolean getBoolean(Object key,
                     BsonBoolean defaultValue)
```
    If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a BsonBoolean.
    
    Parameters:
    key - the key
    defaultValue - the default value
    
    Returns:
    the value of the key as a BsonBoolean
    
    Throws:
    
    BsonInvalidOperationException - if the document contains the key but the value is not of the expected type
  - getString
```
public BsonString getString(Object key,
                   BsonString defaultValue)
```
    If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a BsonString.
    
    Parameters:
    key - the key
    defaultValue - the default value
    
    Returns:
    the value of the key as a BsonString
    
    Throws:
    
    BsonInvalidOperationException - if the document contains the key but the value is not of the expected type
  - getDateTime
```
public BsonDateTime getDateTime(Object key,
                       BsonDateTime defaultValue)
```
    If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a BsonDateTime.
    
    Parameters:
    key - the key
    defaultValue - the default value
    
    Returns:
    the value of the key as a BsonDateTime
    
    Throws:
    
    BsonInvalidOperationException - if the document contains the key but the value is not of the expected type
  - getTimestamp
```
public BsonTimestamp getTimestamp(Object key,
                         BsonTimestamp defaultValue)
```
    If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a Timestamp.
    
    Parameters:
    key - the key
    defaultValue - the default value
    
    Returns:
    the value of the key as a Timestamp
    
    Throws:
    
    BsonInvalidOperationException - if the document contains the key but the value is not of the expected type
  - getObjectId
```
public BsonObjectId getObjectId(Object key,
                       BsonObjectId defaultValue)
```
    If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a ObjectId.
    
    Parameters:
    key - the key
    defaultValue - the default value
    
    Returns:
    the value of the key as a ObjectId
    
    Throws:
    
    BsonInvalidOperationException - if the document contains the key but the value is not of the expected type
  - getBinary
```
public BsonBinary getBinary(Object key,
                   BsonBinary defaultValue)
```
    If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a Binary.
    
    Parameters:
    key - the key
    defaultValue - the default value
    
    Returns:
    the value of the key as a ObjectId
    
    Throws:
    
    BsonInvalidOperationException - if the document contains the key but the value is not of the expected type
  - getRegularExpression
```
public BsonRegularExpression getRegularExpression(Object key,
                                         BsonRegularExpression defaultValue)
```
    If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a ObjectId.
    
    Parameters:
    key - the key
    defaultValue - the default value
    
    Returns:
    the value of the key as a ObjectId
    
    Throws:
    
    BsonInvalidOperationException - if the document contains the key but the value is not of the expected type
  - put
```
public BsonValue put(String key,
            BsonValue value)
```
    Specified by:
    
    put in interface Map<String,BsonValue>
  - remove
```
public BsonValue remove(Object key)
```
    Specified by:
    
    remove in interface Map<String,BsonValue>
  - putAll
```
public void putAll(Map<? extends String,? extends BsonValue> m)
```
    Specified by:
    
    putAll in interface Map<String,BsonValue>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Map<String,BsonValue>
  - keySet
```
public Set<String> keySet()
```
    Specified by:
    
    keySet in interface Map<String,BsonValue>
  - values
```
public Collection<BsonValue> values()
```
    Specified by:
    
    values in interface Map<String,BsonValue>
  - entrySet
```
public Set<Map.Entry<String,BsonValue>> entrySet()
```
    Specified by:
    
    entrySet in interface Map<String,BsonValue>
  - append
```
public BsonDocument append(String key,
                  BsonValue value)
```
    Put the given key and value into this document, and return the document.
    
    Parameters:
    key - the key
    value - the value
    
    Returns:
    this
  - equals
```
public boolean equals(Object o)
```
    Specified by:
    
    equals in interface Map<String,BsonValue>
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Map<String,BsonValue>
    
    Overrides:
    
    hashCode in class Object
  - toJson
```
public String toJson()
```
    Gets a JSON representation of this document
    
    Returns:
    a JSON representation of this document
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class BsonDocument

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class org.bson.BsonValue

Methods inherited from class java.lang.Object

Constructor Detail

BsonDocument

BsonDocument

BsonDocument

Method Detail

getBsonType

size

isEmpty

containsKey

containsValue

get

getDocument

getArray

getNumber

getInt32

getInt64

getDouble

getBoolean

getString

getDateTime

getTimestamp

getObjectId

getRegularExpression

getBinary

isNull

isDocument

isArray

isNumber

isInt32

isInt64

isDouble

isBoolean

isString

isDateTime

isTimestamp

isObjectId

isBinary

get

getDocument

getArray

getNumber

getInt32

getInt64

getDouble

getBoolean

getString

getDateTime

getTimestamp

getObjectId

getBinary

getRegularExpression

put

remove

putAll

clear

keySet

values

entrySet

append

equals

hashCode

toJson

toString