BasicBSONObject (SequoiaDB Java Driver 3.0 API)

java.lang.Object
- org.bson.BasicBSONObject

所有已实现的接口:

Serializable, Map<String,Object>, BSONObject
```
public class BasicBSONObject
extends Object
implements Map<String,Object>, BSONObject
```
A simple implementation of BSONObject. A BSONObject can be created as follows, using this class:
```
 BSONObject obj = new BasicBSONObject();
 obj.put("foo", "bar");
 
```
另请参阅:

序列化表格

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

构造器概要

构造器
构造器和说明
`BasicBSONObject()` Creates an empty object. by default, key won't be sorted
`BasicBSONObject(boolean sort)` Creates an empty object.
`BasicBSONObject(int size)` Creates an empty object. by default, key won't be sorted
`BasicBSONObject(Map m)` Creates a BSONObject from a map.
`BasicBSONObject(String key, Object value)` Convenience CTOR

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`BasicBSONObject`	`append(String key, Object val)` Add a key/value pair to this object
`<T> T`	`as(Class<T> cls)` Return an instance of the class "cls", only for BasicBSONObject
`<T> T`	`as(Class<T> cls, Type eleType)` Return an instance of the class "cls", only for BasicBSONObject.
`Object`	`asMap()`
`boolean`	`BasicTypeWrite(Object object, Object value, Method method)`
`void`	`clear()` Removes all of the mappings from this map (optional operation).
`boolean`	`containsField(String field)` Checks if this object contains a given field
`boolean`	`containsKey(Object key)` Returns true if this map contains a mapping for the specified key.
`boolean`	`containsValue(Object value)` Returns true if this map maps one or more keys to the specified value.
`Set<Map.Entry<String,Object>>`	`entrySet()` Returns a Set view of the mappings contained in this map
`boolean`	`equals(Object o)` Current bson object is equal with the other or not
`Object`	`get(Object key)` Returns the value to which the specified key is mapped, or null if the map contains no mapping for the key.
`Object`	`get(String key)` Gets a value from this object
`BigDecimal`	`getBigDecimal(String field)` Returns the BigDecimal object or null if not set.
`BigDecimal`	`getBigDecimal(String field, BigDecimal def)` Returns the BigDecimal object or def if not set.
`boolean`	`getBoolean(String key)` Returns the value of a field as a boolean.
`boolean`	`getBoolean(String key, boolean def)` Returns the value of a field as a boolean
`Date`	`getDate(String field)` Returns the date or null if not set.
`Date`	`getDate(String field, Date def)` Returns the date or def if not set.
`double`	`getDouble(String key)` Returns the value of a field as a `double`.
`double`	`getDouble(String key, double def)` Returns the value of a field as an `double`.
`int`	`getInt(String key)` Returns the value of a field as an `int`.
`int`	`getInt(String key, int def)` Returns the value of a field as an `int`.
`long`	`getLong(String key)` Returns the value of a field as a `long`.
`long`	`getLong(String key, long def)` Returns the value of a field as an `long`.
`ObjectId`	`getObjectId(String field)` Returns the object id or null if not set.
`ObjectId`	`getObjectId(String field, ObjectId def)` Returns the object id or def if not set.
`String`	`getString(String key)` Returns the value of a field as a string
`String`	`getString(String key, String def)` Returns the value of a field as a string
`int`	`hashCode()`
`boolean`	`isEmpty()` The current bson object keeps any elements or not
`Set<String>`	`keySet()` Returns this object's fields' names
`Object`	`put(String key, Object val)` Add a key/value pair to this object
`void`	`putAll(BSONObject o)` Sets all key/value pairs from an object into this object
`void`	`putAll(Map m)` Sets all key/value pairs from a map into this object
`Object`	`remove(Object key)` Removes the mapping for a key from this map if it is present (optional operation).
`Object`	`removeField(String key)` Deletes a field from this object.
`int`	`size()` Returns the number of key-value mappings in this map.
`Map`	`toMap()` Converts a BSONObject to a map.
`String`	`toString()` Returns a JSON serialization of this object
`static BSONObject`	`typeToBson(Object object)`
`static BSONObject`	`typeToBson(Object object, Boolean ignoreNullValue)`
`Collection<Object>`	`values()` Returns a Collection view of the values contained in this map.

从类继承的方法 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

- 构造器详细资料
  - BasicBSONObject
```
public BasicBSONObject()
```
    Creates an empty object. by default, key won't be sorted
  - BasicBSONObject
```
public BasicBSONObject(boolean sort)
```
    Creates an empty object.
    
    参数:
    
    sort - true: key will be sorted false: key won't be sorted.
  - BasicBSONObject
```
public BasicBSONObject(int size)
```
    Creates an empty object. by default, key won't be sorted
    
    参数:
    
    size - this parament does not work.
  - BasicBSONObject
```
public BasicBSONObject(Map m)
```
    Creates a BSONObject from a map.
    
    参数:
    
    m - map to convert
  - BasicBSONObject
```
public BasicBSONObject(String key,
                       Object value)
```
    Convenience CTOR
    
    参数:
    
    key - key under which to store
    
    value - value to store
- 方法详细资料
  - append
```
public BasicBSONObject append(String key,
                              Object val)
```
    Add a key/value pair to this object
    
    参数:
    
    key - the field name
    
    val - the field value
    
    返回:
    
    this
  - as
```
public <T> T as(Class<T> cls)
         throws Exception
```
    Return an instance of the class "cls", only for BasicBSONObject
    
    指定者:
    
    as 在接口中 BSONObject
    
    参数:
    
    cls - target class object
    
    返回:
    
    the instance of the class
    
    抛出:
    
    Exception - If error happens.
  - as
```
public <T> T as(Class<T> cls,
                Type eleType)
         throws Exception
```
    从接口复制的说明: BSONObject
    
    Return an instance of the class "cls", only for BasicBSONObject.
    
    指定者:
    
    as 在接口中 BSONObject
    
    参数:
    
    cls - target class object
    
    返回:
    
    the instance of the class
    
    抛出:
    
    Exception - If error happens.
  - asMap
```
public Object asMap()
```
  - BasicTypeWrite
```
public boolean BasicTypeWrite(Object object,
                              Object value,
                              Method method)
                       throws IllegalArgumentException,
                              IllegalAccessException,
                              InvocationTargetException
```
    抛出:
    
    IllegalArgumentException
    
    IllegalAccessException
    
    InvocationTargetException
  - clear
```
public void clear()
```
    Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.
    
    指定者:
    
    clear 在接口中 Map<String,Object>
  - containsField
```
public boolean containsField(String field)
```
    Checks if this object contains a given field
    
    指定者:
    
    containsField 在接口中 BSONObject
    
    参数:
    
    field - field name
    
    返回:
    
    if the field exists
  - containsKey
```
public boolean containsKey(Object key)
```
    Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that (key==null ? k==null : key.equals(k)). (There can be at most one such mapping.)
    
    指定者:
    
    containsKey 在接口中 Map<String,Object>
    
    参数:
    
    key - whose presence in this map is to be tested
    
    返回:
    
    true if this map contains a mapping for the specified key
  - containsValue
```
public boolean containsValue(Object value)
```
    Returns true if this map maps one or more keys to the specified value. More formally, returns true if and only if this map contains at least one mapping to a value v such that (value==null ? v==null : value.equals(v)). This operation will probably require time linear in the map size for most implementations of the Map interface.
    
    指定者:
    
    containsValue 在接口中 Map<String,Object>
    
    参数:
    
    value - whose presence in this map is to be tested
    
    返回:
    
    true if this map maps one or more keys to the specified value
  - entrySet
```
public Set<Map.Entry<String,Object>> entrySet()
```
    Returns a Set view of the mappings contained in this map
    
    指定者:
    
    entrySet 在接口中 Map<String,Object>
    
    返回:
    
    Returns a Set view of the mappings contained in this map.
  - equals
```
public boolean equals(Object o)
```
    Current bson object is equal with the other or not
    
    指定者:
    
    equals 在接口中 Map<String,Object>
    
    覆盖:
    
    equals 在类中 Object
    
    返回:
    
    true or false
  - get
```
public Object get(Object key)
```
    Returns the value to which the specified key is mapped, or null if the map contains no mapping for the key.
    
    指定者:
    
    get 在接口中 Map<String,Object>
    
    参数:
    
    key - the key whose associated value is to be returned.
    
    返回:
    
    the value or null
  - get
```
public Object get(String key)
```
    Gets a value from this object
    
    指定者:
    
    get 在接口中 BSONObject
    
    参数:
    
    key - field name
    
    返回:
    
    the value
  - getBigDecimal
```
public BigDecimal getBigDecimal(String field)
```
    Returns the BigDecimal object or null if not set.
    
    参数:
    
    field - The field to return
    
    返回:
    
    The field object value or null if not found.
  - getBigDecimal
```
public BigDecimal getBigDecimal(String field,
                                BigDecimal def)
```
    Returns the BigDecimal object or def if not set.
    
    参数:
    
    field - The field to return
    
    def - the default value in case the field is not found
    
    返回:
    
    The field object value or def if not set.
  - getBoolean
```
public boolean getBoolean(String key)
```
    Returns the value of a field as a boolean.
    
    参数:
    
    key - the field to look up
    
    返回:
    
    the value of the field, or false if field does not exist
  - getBoolean
```
public boolean getBoolean(String key,
                          boolean def)
```
    Returns the value of a field as a boolean
    
    参数:
    
    key - the field to look up
    
    def - the default value in case the field is not found
    
    返回:
    
    the value of the field, converted to a string
  - getDate
```
public Date getDate(String field)
```
    Returns the date or null if not set.
    
    参数:
    
    field - The field to return
    
    返回:
    
    The field object value or null if not found.
  - getDate
```
public Date getDate(String field,
                    Date def)
```
    Returns the date or def if not set.
    
    参数:
    
    field - The field to return
    
    def - the default value in case the field is not found
    
    返回:
    
    The field object value or def if not set.
  - getDouble
```
public double getDouble(String key)
```
    Returns the value of a field as a double.
    
    参数:
    
    key - the field to return
    
    返回:
    
    the field value
  - getDouble
```
public double getDouble(String key,
                        double def)
```
    Returns the value of a field as an double.
    
    参数:
    
    key - the field to look for
    
    def - the default to return
    
    返回:
    
    the field value (or default)
  - getInt
```
public int getInt(String key)
```
    Returns the value of a field as an int.
    
    参数:
    
    key - the field to look for
    
    返回:
    
    the field value (or default)
  - getInt
```
public int getInt(String key,
                  int def)
```
    Returns the value of a field as an int.
    
    参数:
    
    key - the field to look for
    
    def - the default to return
    
    返回:
    
    the field value (or default)
  - getLong
```
public long getLong(String key)
```
    Returns the value of a field as a long.
    
    参数:
    
    key - the field to return
    
    返回:
    
    the field value
  - getLong
```
public long getLong(String key,
                    long def)
```
    Returns the value of a field as an long.
    
    参数:
    
    key - the field to look for
    
    def - the default to return
    
    返回:
    
    the field value (or default)
  - getObjectId
```
public ObjectId getObjectId(String field)
```
    Returns the object id or null if not set.
    
    参数:
    
    field - The field to return
    
    返回:
    
    The field object value or null if not found (or if null :-^).
  - getObjectId
```
public ObjectId getObjectId(String field,
                            ObjectId def)
```
    Returns the object id or def if not set.
    
    参数:
    
    field - The field to return
    
    def - the default value in case the field is not found
    
    返回:
    
    The field object value or def if not set.
  - getString
```
public String getString(String key)
```
    Returns the value of a field as a string
    
    参数:
    
    key - the field to look up
    
    返回:
    
    the value of the field, converted to a string
  - getString
```
public String getString(String key,
                        String def)
```
    Returns the value of a field as a string
    
    参数:
    
    key - the field to look up
    
    def - the default to return
    
    返回:
    
    the value of the field, converted to a string
  - hashCode
```
public int hashCode()
```
    指定者:
    
    hashCode 在接口中 Map<String,Object>
    
    覆盖:
    
    hashCode 在类中 Object
  - isEmpty
```
public boolean isEmpty()
```
    The current bson object keeps any elements or not
    
    指定者:
    
    isEmpty 在接口中 Map<String,Object>
    
    指定者:
    
    isEmpty 在接口中 BSONObject
    
    返回:
    
    true for empty, false for not
  - keySet
```
public Set<String> keySet()
```
    Returns this object's fields' names
    
    指定者:
    
    keySet 在接口中 Map<String,Object>
    
    指定者:
    
    keySet 在接口中 BSONObject
    
    返回:
    
    The names of the fields in this object
  - put
```
public Object put(String key,
                  Object val)
```
    Add a key/value pair to this object
    
    指定者:
    
    put 在接口中 Map<String,Object>
    
    指定者:
    
    put 在接口中 BSONObject
    
    参数:
    
    key - the field name
    
    val - the field value
    
    返回:
    
    the val parameter
  - putAll
```
public void putAll(BSONObject o)
```
    Sets all key/value pairs from an object into this object
    
    指定者:
    
    putAll 在接口中 BSONObject
    
    参数:
    
    o - the object
  - putAll
```
public void putAll(Map m)
```
    Sets all key/value pairs from a map into this object
    
    指定者:
    
    putAll 在接口中 Map<String,Object>
    
    指定者:
    
    putAll 在接口中 BSONObject
    
    参数:
    
    m - the map
  - remove
```
public Object remove(Object key)
```
    Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key k to value v such that (key==null ? k==null : key.equals(k)), that mapping is removed. (The map can contain at most one such mapping.) Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key. If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null. The map will not contain a mapping for the specified key once the call returns.
    
    指定者:
    
    remove 在接口中 Map<String,Object>
    
    参数:
    
    key - whose mapping is to be removed from the map
    
    返回:
    
    the previous value associated with key, or null if there was no mapping for key.
  - removeField
```
public Object removeField(String key)
```
    Deletes a field from this object.
    
    指定者:
    
    removeField 在接口中 BSONObject
    
    参数:
    
    key - the field name to remove
    
    返回:
    
    the object removed
  - size
```
public int size()
```
    Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
    
    指定者:
    
    size 在接口中 Map<String,Object>
    
    返回:
    
    the number of key-value mappings in this map
  - toMap
```
public Map toMap()
```
    Converts a BSONObject to a map.
    
    指定者:
    
    toMap 在接口中 BSONObject
    
    返回:
    
    the BSONObject
  - toString
```
public String toString()
```
    Returns a JSON serialization of this object
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    JSON serialization
  - typeToBson
```
public static BSONObject typeToBson(Object object)
                             throws IntrospectionException,
                                    IllegalArgumentException,
                                    IllegalAccessException,
                                    InvocationTargetException
```
    抛出:
    
    IntrospectionException
    
    IllegalArgumentException
    
    IllegalAccessException
    
    InvocationTargetException
  - typeToBson
```
public static BSONObject typeToBson(Object object,
                                    Boolean ignoreNullValue)
                             throws IntrospectionException,
                                    IllegalArgumentException,
                                    IllegalAccessException,
                                    InvocationTargetException
```
    抛出:
    
    IntrospectionException
    
    IllegalArgumentException
    
    IllegalAccessException
    
    InvocationTargetException
  - values
```
public Collection<Object> values()
```
    Returns a Collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.
    
    指定者:
    
    values 在接口中 Map<String,Object>
    
    返回:
    
    a collection view of the values contained in this map

类 BasicBSONObject

嵌套类概要

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

构造器概要

方法概要

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

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

构造器详细资料

BasicBSONObject

BasicBSONObject

BasicBSONObject

BasicBSONObject

BasicBSONObject

方法详细资料

append

as

as

asMap

BasicTypeWrite

clear

containsField

containsKey

containsValue

entrySet

equals

get

get

getBigDecimal

getBigDecimal

getBoolean

getBoolean

getDate

getDate

getDouble

getDouble

getInt

getInt

getLong

getLong

getObjectId

getObjectId

getString

getString

hashCode

isEmpty

keySet

put

putAll

putAll

remove

removeField

size

toMap

toString

typeToBson

typeToBson

values