java.lang.Object
- org.bson.BsonValue
- - org.bson.BsonDocument
  - - org.bson.BsonDocumentWrapper<T>

Type Parameters:

T - the type of the document that is wrapped

All Implemented Interfaces:

Serializable, Cloneable, Map<String,BsonValue>, Bson
```
public final class BsonDocumentWrapper<T>
extends BsonDocument
```
A BsonDocument that begins its life as a document of any type and an Encoder for that document, which lets an instance of any class with an Encoder be treated as a BsonDocument. If any methods are called which required access to the individual elements of the document, then, on demand, the document will be unwrapped into a BsonDocument using a BsonDocumentWriter and the Encoder. But if all that is done with this document is to encode it, then the Encoder will be used to do that.

Since:

3.0

See Also:

BsonDocumentWriter, Serialized Form

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

Constructor Summary

Constructors
Constructor	Description
`BsonDocumentWrapper(T wrappedDocument, Encoder<T> encoder)`	Construct a new instance with the given document and encoder for the document.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static BsonDocument`	`asBsonDocument(Object document, CodecRegistry codecRegistry)`	A helper to convert an document of type Object to a BsonDocument
`void`	`clear()`
`BsonDocument`	`clone()`
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`Set<Map.Entry<String,BsonValue>>`	`entrySet()`
`boolean`	`equals(Object o)`
`BsonValue`	`get(Object key)`
`Encoder<T>`	`getEncoder()`	Get the encoder to use for the wrapped document.
`T`	`getWrappedDocument()`	Get the wrapped document.
`int`	`hashCode()`
`boolean`	`isEmpty()`
`boolean`	`isUnwrapped()`	Determine whether the document has been unwrapped already.
`Set<String>`	`keySet()`
`BsonValue`	`put(String key, BsonValue value)`
`void`	`putAll(Map<? extends String,? extends BsonValue> m)`
`BsonValue`	`remove(Object key)`
`int`	`size()`
`String`	`toString()`
`Collection<BsonValue>`	`values()`

Methods inherited from class org.bson.BsonDocument
append, asBsonReader, get, getArray, getArray, getBinary, getBinary, getBoolean, getBoolean, getBsonType, getDateTime, getDateTime, getDecimal128, getDecimal128, getDocument, getDocument, getDouble, getDouble, getFirstKey, getInt32, getInt32, getInt64, getInt64, getNumber, getNumber, getObjectId, getObjectId, getRegularExpression, getRegularExpression, getString, getString, getTimestamp, getTimestamp, isArray, isBinary, isBoolean, isDateTime, isDecimal128, isDocument, isDouble, isInt32, isInt64, isNull, isNumber, isObjectId, isString, isTimestamp, parse, toBsonDocument, toJson, toJson

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

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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - BsonDocumentWrapper
```
public BsonDocumentWrapper(T wrappedDocument,
                           Encoder<T> encoder)
```
    Construct a new instance with the given document and encoder for the document.
    
    Parameters:
    
    wrappedDocument - the wrapped document
    
    encoder - the encoder for the wrapped document
- Method Detail
  - asBsonDocument
```
public static BsonDocument asBsonDocument(Object document,
                                          CodecRegistry codecRegistry)
```
    A helper to convert an document of type Object to a BsonDocument
    If not already a BsonDocument it looks up the documents' class in the codecRegistry and wraps it into a BsonDocumentWrapper
    
    Parameters:
    
    document - the document to convert
    
    codecRegistry - the codecRegistry that can be used in the conversion of the Object
    
    Returns:
    
    a BsonDocument
  - getWrappedDocument
```
public T getWrappedDocument()
```
    Get the wrapped document.
    
    Returns:
    
    the wrapped document
  - getEncoder
```
public Encoder<T> getEncoder()
```
    Get the encoder to use for the wrapped document.
    
    Returns:
    
    the encoder
  - isUnwrapped
```
public boolean isUnwrapped()
```
    Determine whether the document has been unwrapped already.
    
    Returns:
    
    true if the wrapped document has been unwrapped already
  - size
```
public int size()
```
    Specified by:
    
    size in interface Map<String,BsonValue>
    
    Overrides:
    
    size in class BsonDocument
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Map<String,BsonValue>
    
    Overrides:
    
    isEmpty in class BsonDocument
  - containsKey
```
public boolean containsKey(Object key)
```
    Specified by:
    
    containsKey in interface Map<String,BsonValue>
    
    Overrides:
    
    containsKey in class BsonDocument
  - containsValue
```
public boolean containsValue(Object value)
```
    Specified by:
    
    containsValue in interface Map<String,BsonValue>
    
    Overrides:
    
    containsValue in class BsonDocument
  - get
```
public BsonValue get(Object key)
```
    Specified by:
    
    get in interface Map<String,BsonValue>
    
    Overrides:
    
    get in class BsonDocument
  - put
```
public BsonValue put(String key,
                     BsonValue value)
```
    Specified by:
    
    put in interface Map<String,BsonValue>
    
    Overrides:
    
    put in class BsonDocument
  - remove
```
public BsonValue remove(Object key)
```
    Specified by:
    
    remove in interface Map<String,BsonValue>
    
    Overrides:
    
    remove in class BsonDocument
  - putAll
```
public void putAll(Map<? extends String,? extends BsonValue> m)
```
    Specified by:
    
    putAll in interface Map<String,BsonValue>
    
    Overrides:
    
    putAll in class BsonDocument
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Map<String,BsonValue>
    
    Overrides:
    
    clear in class BsonDocument
  - keySet
```
public Set<String> keySet()
```
    Specified by:
    
    keySet in interface Map<String,BsonValue>
    
    Overrides:
    
    keySet in class BsonDocument
  - values
```
public Collection<BsonValue> values()
```
    Specified by:
    
    values in interface Map<String,BsonValue>
    
    Overrides:
    
    values in class BsonDocument
  - entrySet
```
public Set<Map.Entry<String,BsonValue>> entrySet()
```
    Specified by:
    
    entrySet in interface Map<String,BsonValue>
    
    Overrides:
    
    entrySet in class BsonDocument
  - equals
```
public boolean equals(Object o)
```
    Specified by:
    
    equals in interface Map<String,BsonValue>
    
    Overrides:
    
    equals in class BsonDocument
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Map<String,BsonValue>
    
    Overrides:
    
    hashCode in class BsonDocument
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class BsonDocument
  - clone
```
public BsonDocument clone()
```
    Overrides:
    
    clone in class BsonDocument

Class BsonDocumentWrapper<T>

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class org.bson.BsonDocument

Methods inherited from class org.bson.BsonValue

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

BsonDocumentWrapper

Method Detail

asBsonDocument

getWrappedDocument

getEncoder

isUnwrapped

size

isEmpty

containsKey

containsValue

get

put

remove

putAll

clear

keySet

values

entrySet

equals

hashCode

toString

clone