Package org.bson
Class BasicBSONObject
- java.lang.Object
-
- java.util.AbstractMap<K,V>
-
- java.util.HashMap<K,V>
-
- java.util.LinkedHashMap<String,Object>
-
- org.bson.BasicBSONObject
-
- All Implemented Interfaces:
Serializable
,Cloneable
,Map<String,Object>
,BSONObject
public class BasicBSONObject extends LinkedHashMap<String,Object> implements BSONObject
A simple implementation ofDBObject
. ADBObject
can be created as follows, using this class:DBObject obj = new BasicBSONObject(); obj.put( "foo", "bar" );
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>
-
-
Constructor Summary
Constructors Constructor Description BasicBSONObject()
Creates an empty object.BasicBSONObject(int size)
Creates an empty object.BasicBSONObject(String key, Object value)
Creates a BSONObject initialised with a single key/value pair.BasicBSONObject(Map map)
Creates a DBObject from a map.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BasicBSONObject
append(String key, Object val)
Add a key/value pair to this objectboolean
containsField(String field)
Checks if this object contains a given fieldboolean
equals(Object o)
Compares two documents according to their serialized form, ignoring the order of keys.Object
get(String key)
Gets a value from this objectboolean
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 booleanDate
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 adouble
.double
getDouble(String key, double def)
Returns the value of a field as andouble
.int
getInt(String key)
Returns the value of a field as anint
.int
getInt(String key, int def)
Returns the value of a field as anint
.long
getLong(String key)
Returns the value of a field as along
.long
getLong(String key, long def)
Returns the value of a field as anlong
.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 stringString
getString(String key, String def)
Returns the value of a field as a stringint
hashCode()
void
putAll(Map m)
Sets all key/value pairs from a map into this objectvoid
putAll(BSONObject o)
Sets all key/value pairs from an object into this objectObject
removeField(String key)
Deletes a field from this object.Map
toMap()
Converts a DBObject to a map.-
Methods inherited from class java.util.LinkedHashMap
clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, removeEldestEntry, replaceAll, values
-
Methods inherited from class java.util.HashMap
clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, put, putIfAbsent, remove, remove, replace, replace, size
-
Methods inherited from class java.util.AbstractMap
toString
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.bson.BSONObject
keySet, put
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, put, putIfAbsent, remove, remove, replace, replace, size
-
-
-
-
Constructor Detail
-
BasicBSONObject
public BasicBSONObject()
Creates an empty object.
-
BasicBSONObject
public BasicBSONObject(int size)
Creates an empty object.- Parameters:
size
- the initial capacity for the Map storing this document.
-
BasicBSONObject
public BasicBSONObject(String key, Object value)
Creates a BSONObject initialised with a single key/value pair.- Parameters:
key
- key under which to storevalue
- value to store
-
BasicBSONObject
public BasicBSONObject(Map map)
Creates a DBObject from a map.- Parameters:
map
- map to convert
-
-
Method Detail
-
toMap
public Map toMap()
Converts a DBObject to a map.- Specified by:
toMap
in interfaceBSONObject
- Returns:
- the DBObject
-
removeField
public Object removeField(String key)
Deletes a field from this object.- Specified by:
removeField
in interfaceBSONObject
- Parameters:
key
- the field name to remove- Returns:
- the object removed
-
containsField
public boolean containsField(String field)
Checks if this object contains a given field- Specified by:
containsField
in interfaceBSONObject
- Parameters:
field
- field name- Returns:
- if the field exists
-
get
public Object get(String key)
Gets a value from this object- Specified by:
get
in interfaceBSONObject
- Parameters:
key
- field name- Returns:
- the value
-
getInt
public int getInt(String key)
Returns the value of a field as anint
.- Parameters:
key
- the field to look for- Returns:
- the field value (or default)
-
getInt
public int getInt(String key, int def)
Returns the value of a field as anint
.- Parameters:
key
- the field to look fordef
- the default to return- Returns:
- the field value (or default)
-
getLong
public long getLong(String key)
Returns the value of a field as along
.- Parameters:
key
- the field to return- Returns:
- the field value
-
getLong
public long getLong(String key, long def)
Returns the value of a field as anlong
.- Parameters:
key
- the field to look fordef
- the default to return- Returns:
- the field value (or default)
-
getDouble
public double getDouble(String key)
Returns the value of a field as adouble
.- Parameters:
key
- the field to return- Returns:
- the field value
-
getDouble
public double getDouble(String key, double def)
Returns the value of a field as andouble
.- Parameters:
key
- the field to look fordef
- the default to return- Returns:
- the field value (or default)
-
getString
public String getString(String key)
Returns the value of a field as a string- Parameters:
key
- the field to look up- Returns:
- 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- Parameters:
key
- the field to look updef
- the default to return- Returns:
- the value of the field, converted to a string
-
getBoolean
public boolean getBoolean(String key)
Returns the value of a field as a boolean.- Parameters:
key
- the field to look up- Returns:
- 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- Parameters:
key
- the field to look updef
- the default value in case the field is not found- Returns:
- the value of the field, converted to a string
-
getObjectId
public ObjectId getObjectId(String field)
Returns the object id or null if not set.- Parameters:
field
- The field to return- Returns:
- 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.- Parameters:
field
- The field to returndef
- the default value in case the field is not found- Returns:
- The field object value or def if not set.
-
getDate
public Date getDate(String field)
Returns the date or null if not set.- Parameters:
field
- The field to return- Returns:
- 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.- Parameters:
field
- The field to returndef
- the default value in case the field is not found- Returns:
- The field object value or def if not set.
-
putAll
public void putAll(Map m)
Description copied from interface:BSONObject
Sets all key/value pairs from a map into this object
-
putAll
public void putAll(BSONObject o)
Description copied from interface:BSONObject
Sets all key/value pairs from an object into this object- Specified by:
putAll
in interfaceBSONObject
- Parameters:
o
- the object
-
append
public BasicBSONObject append(String key, Object val)
Add a key/value pair to this object- Parameters:
key
- the field nameval
- the field value- Returns:
this
-
equals
public boolean equals(Object o)
Compares two documents according to their serialized form, ignoring the order of keys.- Specified by:
equals
in interfaceMap<String,Object>
- Overrides:
equals
in classAbstractMap<String,Object>
- Parameters:
o
- the document to compare to, which must be an instance ofBSONObject
.- Returns:
- true if the documents have the same serialized form, ignoring key order.
-
-