Document (mongo-java-driver 3.3.0-query-log-max-size API)

java.lang.Object
- org.bson.Document

所有已实现的接口:

java.io.Serializable, java.util.Map<java.lang.String,java.lang.Object>, Bson
```
public class Document
extends java.lang.Object
implements java.util.Map<java.lang.String,java.lang.Object>, java.io.Serializable, Bson
```
A representation of a document as a Map. All iterators will traverse the elements in insertion order, as with LinkedHashMap.

从以下版本开始:

3.0.0

另请参阅:

序列化表格

MongoDB documentation

document

嵌套类概要
- 从接口继承的嵌套类/接口 java.util.Map
  java.util.Map.Entry<K,V>

构造器概要

构造器
构造器和说明
`Document()` Creates an empty Document instance.
`Document(java.util.Map<java.lang.String,java.lang.Object> map)` Creates a Document instance initialized with the given map.
`Document(java.lang.String key, java.lang.Object value)` Create a Document instance initialized with the given key/value pair.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`Document`	`append(java.lang.String key, java.lang.Object value)` Put the given key/value pair into this Document and return this.
`void`	`clear()`
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.Object value)`
`java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>>`	`entrySet()`
`boolean`	`equals(java.lang.Object o)`
`java.lang.Object`	`get(java.lang.Object key)`
`<T> T`	`get(java.lang.Object key, java.lang.Class<T> clazz)` Gets the value of the given key, casting it to the given `Class<T>`.
`java.lang.Boolean`	`getBoolean(java.lang.Object key)` Gets the value of the given key as a Boolean.
`boolean`	`getBoolean(java.lang.Object key, boolean defaultValue)` Gets the value of the given key as a primitive boolean.
`java.util.Date`	`getDate(java.lang.Object key)` Gets the value of the given key as a Date.
`java.lang.Double`	`getDouble(java.lang.Object key)` Gets the value of the given key as a Double.
`java.lang.Integer`	`getInteger(java.lang.Object key)` Gets the value of the given key as an Integer.
`int`	`getInteger(java.lang.Object key, int defaultValue)` Gets the value of the given key as a primitive int.
`java.lang.Long`	`getLong(java.lang.Object key)` Gets the value of the given key as a Long.
`ObjectId`	`getObjectId(java.lang.Object key)` Gets the value of the given key as an ObjectId.
`java.lang.String`	`getString(java.lang.Object key)` Gets the value of the given key as a String.
`int`	`hashCode()`
`boolean`	`isEmpty()`
`java.util.Set<java.lang.String>`	`keySet()`
`static Document`	`parse(java.lang.String json)` Parses a string in MongoDB Extended JSON format to a `Document`
`static Document`	`parse(java.lang.String json, Decoder<Document> decoder)` Parses a string in MongoDB Extended JSON format to a `Document`
`java.lang.Object`	`put(java.lang.String key, java.lang.Object value)`
`void`	`putAll(java.util.Map<? extends java.lang.String,?> map)`
`java.lang.Object`	`remove(java.lang.Object key)`
`int`	`size()`
`<C> BsonDocument`	`toBsonDocument(java.lang.Class<C> documentClass, CodecRegistry codecRegistry)` Render the filter into a BsonDocument.
`java.lang.String`	`toJson()` Gets a JSON representation of this document With the default `JsonWriterSettings` and `DocumentCodec`.
`java.lang.String`	`toJson(Encoder<Document> encoder)` Gets a JSON representation of this document With the default `JsonWriterSettings`.
`java.lang.String`	`toJson(JsonWriterSettings writerSettings)` Gets a JSON representation of this document With the default `DocumentCodec`.
`java.lang.String`	`toJson(JsonWriterSettings writerSettings, Encoder<Document> encoder)` Gets a JSON representation of this document
`java.lang.String`	`toString()`
`java.util.Collection<java.lang.Object>`	`values()`

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- 构造器详细资料
  - Document
```
public Document()
```
    Creates an empty Document instance.
  - Document
```
public Document(java.lang.String key,
                java.lang.Object value)
```
    Create a Document instance initialized with the given key/value pair.
    
    参数:
    
    key - key
    
    value - value
  - Document
```
public Document(java.util.Map<java.lang.String,java.lang.Object> map)
```
    Creates a Document instance initialized with the given map.
    
    参数:
    
    map - initial map
- 方法详细资料
  - parse
```
public static Document parse(java.lang.String json)
```
    Parses a string in MongoDB Extended JSON format to a Document
    
    参数:
    
    json - the JSON string
    
    返回:
    
    a corresponding Document object
    
    另请参阅:
    
    JsonReader
    
    MongoDB documentation
    
    MongoDB Extended JSON
  - parse
```
public static Document parse(java.lang.String json,
                             Decoder<Document> decoder)
```
    Parses a string in MongoDB Extended JSON format to a Document
    
    参数:
    
    json - the JSON string
    
    decoder - the Decoder to use to parse the JSON string into a Document
    
    返回:
    
    a corresponding Document object
    
    另请参阅:
    
    JsonReader
    
    MongoDB documentation
    
    MongoDB Extended JSON
  - toBsonDocument
```
public <C> BsonDocument toBsonDocument(java.lang.Class<C> documentClass,
                                       CodecRegistry codecRegistry)
```
    从接口复制的说明: Bson
    
    Render the filter into a BsonDocument.
    
    指定者:
    
    toBsonDocument 在接口中 Bson
    
    类型参数:
    
    C - the type of the document class
    
    参数:
    
    documentClass - the document class in scope for the collection. This parameter may be ignored, but it may be used to alter the structure of the returned BsonDocument based on some knowledge of the document class.
    
    codecRegistry - the codec registry. This parameter may be ignored, but it may be used to look up Codec instances for the document class or any other related class.
    
    返回:
    
    the BsonDocument
  - append
```
public Document append(java.lang.String key,
                       java.lang.Object value)
```
    Put the given key/value pair into this Document and return this. Useful for chaining puts in a single expression, e.g.
```
 doc.append("a", 1).append("b", 2)}
 
```
    参数:
    
    key - key
    
    value - value
    
    返回:
    
    this
  - get
```
public <T> T get(java.lang.Object key,
                 java.lang.Class<T> clazz)
```
    Gets the value of the given key, casting it to the given Class<T>. This is useful to avoid having casts in client code, though the effect is the same. So to get the value of a key that is of type String, you would write String name = doc.get("name", String.class) instead of String name = (String) doc.get("x") .
    
    类型参数:
    
    T - the type of the class
    
    参数:
    
    key - the key
    
    clazz - the non-null class to cast the value to
    
    返回:
    
    the value of the given key, or null if the instance does not contain this key.
    
    抛出:
    
    java.lang.ClassCastException - if the value of the given key is not of type T
  - getInteger
```
public java.lang.Integer getInteger(java.lang.Object key)
```
    Gets the value of the given key as an Integer.
    
    参数:
    
    key - the key
    
    返回:
    
    the value as an integer, which may be null
    
    抛出:
    
    java.lang.ClassCastException - if the value is not an integer
  - getInteger
```
public int getInteger(java.lang.Object key,
                      int defaultValue)
```
    Gets the value of the given key as a primitive int.
    
    参数:
    
    key - the key
    
    defaultValue - what to return if the value is null
    
    返回:
    
    the value as an integer, which may be null
    
    抛出:
    
    java.lang.ClassCastException - if the value is not an integer
  - getLong
```
public java.lang.Long getLong(java.lang.Object key)
```
    Gets the value of the given key as a Long.
    
    参数:
    
    key - the key
    
    返回:
    
    the value as a long, which may be null
    
    抛出:
    
    java.lang.ClassCastException - if the value is not an long
  - getDouble
```
public java.lang.Double getDouble(java.lang.Object key)
```
    Gets the value of the given key as a Double.
    
    参数:
    
    key - the key
    
    返回:
    
    the value as a double, which may be null
    
    抛出:
    
    java.lang.ClassCastException - if the value is not an double
  - getString
```
public java.lang.String getString(java.lang.Object key)
```
    Gets the value of the given key as a String.
    
    参数:
    
    key - the key
    
    返回:
    
    the value as a String, which may be null
    
    抛出:
    
    java.lang.ClassCastException - if the value is not a String
  - getBoolean
```
public java.lang.Boolean getBoolean(java.lang.Object key)
```
    Gets the value of the given key as a Boolean.
    
    参数:
    
    key - the key
    
    返回:
    
    the value as a double, which may be null
    
    抛出:
    
    java.lang.ClassCastException - if the value is not an double
  - getBoolean
```
public boolean getBoolean(java.lang.Object key,
                          boolean defaultValue)
```
    Gets the value of the given key as a primitive boolean.
    
    参数:
    
    key - the key
    
    defaultValue - what to return if the value is null
    
    返回:
    
    the value as a double, which may be null
    
    抛出:
    
    java.lang.ClassCastException - if the value is not an double
  - getObjectId
```
public ObjectId getObjectId(java.lang.Object key)
```
    Gets the value of the given key as an ObjectId.
    
    参数:
    
    key - the key
    
    返回:
    
    the value as an ObjectId, which may be null
    
    抛出:
    
    java.lang.ClassCastException - if the value is not an ObjectId
  - getDate
```
public java.util.Date getDate(java.lang.Object key)
```
    Gets the value of the given key as a Date.
    
    参数:
    
    key - the key
    
    返回:
    
    the value as a Date, which may be null
    
    抛出:
    
    java.lang.ClassCastException - if the value is not a Date
  - toJson
```
public java.lang.String toJson()
```
    Gets a JSON representation of this document
    With the default JsonWriterSettings and DocumentCodec.
    
    返回:
    
    a JSON representation of this document
    
    抛出:
    
    CodecConfigurationException - if the document contains types not in the default registry
  - toJson
```
public java.lang.String toJson(JsonWriterSettings writerSettings)
```
    Gets a JSON representation of this document
    With the default DocumentCodec.
    
    参数:
    
    writerSettings - the json writer settings to use when encoding
    
    返回:
    
    a JSON representation of this document
    
    抛出:
    
    CodecConfigurationException - if the document contains types not in the default registry
  - toJson
```
public java.lang.String toJson(Encoder<Document> encoder)
```
    Gets a JSON representation of this document
    With the default JsonWriterSettings.
    
    参数:
    
    encoder - the document codec instance to use to encode the document
    
    返回:
    
    a JSON representation of this document
    
    抛出:
    
    CodecConfigurationException - if the registry does not contain a codec for the document values.
  - toJson
```
public java.lang.String toJson(JsonWriterSettings writerSettings,
                               Encoder<Document> encoder)
```
    Gets a JSON representation of this document
    
    参数:
    
    writerSettings - the json writer settings to use when encoding
    
    encoder - the document codec instance to use to encode the document
    
    返回:
    
    a JSON representation of this document
    
    抛出:
    
    CodecConfigurationException - if the registry does not contain a codec for the document values.
  - size
```
public int size()
```
    指定者:
    
    size 在接口中 java.util.Map<java.lang.String,java.lang.Object>
  - isEmpty
```
public boolean isEmpty()
```
    指定者:
    
    isEmpty 在接口中 java.util.Map<java.lang.String,java.lang.Object>
  - containsValue
```
public boolean containsValue(java.lang.Object value)
```
    指定者:
    
    containsValue 在接口中 java.util.Map<java.lang.String,java.lang.Object>
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    指定者:
    
    containsKey 在接口中 java.util.Map<java.lang.String,java.lang.Object>
  - get
```
public java.lang.Object get(java.lang.Object key)
```
    指定者:
    
    get 在接口中 java.util.Map<java.lang.String,java.lang.Object>
  - put
```
public java.lang.Object put(java.lang.String key,
                            java.lang.Object value)
```
    指定者:
    
    put 在接口中 java.util.Map<java.lang.String,java.lang.Object>
  - remove
```
public java.lang.Object remove(java.lang.Object key)
```
    指定者:
    
    remove 在接口中 java.util.Map<java.lang.String,java.lang.Object>
  - putAll
```
public void putAll(java.util.Map<? extends java.lang.String,?> map)
```
    指定者:
    
    putAll 在接口中 java.util.Map<java.lang.String,java.lang.Object>
  - clear
```
public void clear()
```
    指定者:
    
    clear 在接口中 java.util.Map<java.lang.String,java.lang.Object>
  - keySet
```
public java.util.Set<java.lang.String> keySet()
```
    指定者:
    
    keySet 在接口中 java.util.Map<java.lang.String,java.lang.Object>
  - values
```
public java.util.Collection<java.lang.Object> values()
```
    指定者:
    
    values 在接口中 java.util.Map<java.lang.String,java.lang.Object>
  - entrySet
```
public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> entrySet()
```
    指定者:
    
    entrySet 在接口中 java.util.Map<java.lang.String,java.lang.Object>
  - equals
```
public boolean equals(java.lang.Object o)
```
    指定者:
    
    equals 在接口中 java.util.Map<java.lang.String,java.lang.Object>
    
    覆盖:
    
    equals 在类中 java.lang.Object
  - hashCode
```
public int hashCode()
```
    指定者:
    
    hashCode 在接口中 java.util.Map<java.lang.String,java.lang.Object>
    
    覆盖:
    
    hashCode 在类中 java.lang.Object
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object

类 Document

嵌套类概要

从接口继承的嵌套类/接口 java.util.Map

构造器概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 java.util.Map

构造器详细资料

Document

Document

Document

方法详细资料

parse

parse

toBsonDocument

append

get

getInteger

getInteger

getLong

getDouble

getString

getBoolean

getBoolean

getObjectId

getDate

toJson

toJson

toJson

toJson

size

isEmpty

containsValue

containsKey

get

put

remove

putAll

clear

keySet

values

entrySet

equals

hashCode

toString