org.bson
Class BasicBSONObject

java.lang.Object
  extended by java.util.AbstractMap<K,V>
      extended by java.util.HashMap<K,V>
          extended by java.util.LinkedHashMap<java.lang.String,java.lang.Object>
              extended by org.bson.BasicBSONObject
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>, BSONObject
Direct Known Subclasses:
BasicDBObject

public class BasicBSONObject
extends java.util.LinkedHashMap<java.lang.String,java.lang.Object>
implements BSONObject

A simple implementation of DBObject. A DBObject 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
java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
 
Constructor Summary
BasicBSONObject()
          Creates an empty object.
BasicBSONObject(java.util.Map m)
          Creates a DBObject from a map.
BasicBSONObject(java.lang.String key, java.lang.Object value)
          Convenience CTOR
 
Method Summary
 BasicBSONObject append(java.lang.String key, java.lang.Object val)
          Add a key/value pair to this object
 boolean containsField(java.lang.String field)
          Checks if this object contains a given field
 boolean containsKey(java.lang.String key)
          Deprecated.  
 boolean equals(java.lang.Object o)
           
 java.lang.Object get(java.lang.String key)
          Gets a value from this object
 boolean getBoolean(java.lang.String key, boolean def)
           
 double getDouble(java.lang.String key)
          Returns the value of a field as a double.
 int getInt(java.lang.String key)
          Returns the value of a field as an int.
 int getInt(java.lang.String key, int def)
          Returns the value of a field as an int.
 long getLong(java.lang.String key)
          Returns the value of a field as a long.
 java.lang.String getString(java.lang.String key)
          Returns the value of a field as a string
 java.lang.Object put(java.lang.String key, java.lang.Object val)
          Add a key/value pair to this object
 void putAll(BSONObject o)
           
 void putAll(java.util.Map m)
           
 java.lang.Object removeField(java.lang.String key)
          Deletes a field from this object.
 java.util.Map toMap()
          Converts a DBObject to a map.
 java.lang.String toString()
          Returns a JSON serialization of this object
 
Methods inherited from class java.util.LinkedHashMap
clear, containsValue, get, removeEldestEntry
 
Methods inherited from class java.util.HashMap
clone, containsKey, entrySet, isEmpty, keySet, remove, size, values
 
Methods inherited from class java.util.AbstractMap
hashCode
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.bson.BSONObject
keySet
 
Methods inherited from interface java.util.Map
containsKey, entrySet, hashCode, isEmpty, keySet, remove, size, values
 

Constructor Detail

BasicBSONObject

public BasicBSONObject()
Creates an empty object.


BasicBSONObject

public BasicBSONObject(java.lang.String key,
                       java.lang.Object value)
Convenience CTOR

Parameters:
key - key under which to store
value - value to stor

BasicBSONObject

public BasicBSONObject(java.util.Map m)
Creates a DBObject from a map.

Parameters:
m - map to convert
Method Detail

toMap

public java.util.Map toMap()
Converts a DBObject to a map.

Specified by:
toMap in interface BSONObject
Returns:
the DBObject

removeField

public java.lang.Object removeField(java.lang.String key)
Deletes a field from this object.

Specified by:
removeField in interface BSONObject
Parameters:
key - the field name to remove
Returns:
the object removed

containsField

public boolean containsField(java.lang.String field)
Checks if this object contains a given field

Specified by:
containsField in interface BSONObject
Parameters:
field - field name
Returns:
if the field exists

containsKey

public boolean containsKey(java.lang.String key)
Deprecated. 

Specified by:
containsKey in interface BSONObject

get

public java.lang.Object get(java.lang.String key)
Gets a value from this object

Specified by:
get in interface BSONObject
Parameters:
key - field name
Returns:
the value

getInt

public int getInt(java.lang.String key)
Returns the value of a field as an int.

Parameters:
key - the field to look for
Returns:
the field value (or default)

getInt

public int getInt(java.lang.String key,
                  int def)
Returns the value of a field as an int.

Parameters:
key - the field to look for
def - the default to return
Returns:
the field value (or default)

getLong

public long getLong(java.lang.String key)
Returns the value of a field as a long.

Parameters:
key - the field to return
Returns:
the field value

getDouble

public double getDouble(java.lang.String key)
Returns the value of a field as a double.

Parameters:
key - the field to return
Returns:
the field value

getString

public java.lang.String getString(java.lang.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

getBoolean

public boolean getBoolean(java.lang.String key,
                          boolean def)

put

public java.lang.Object put(java.lang.String key,
                            java.lang.Object val)
Add a key/value pair to this object

Specified by:
put in interface java.util.Map<java.lang.String,java.lang.Object>
Specified by:
put in interface BSONObject
Overrides:
put in class java.util.HashMap<java.lang.String,java.lang.Object>
Parameters:
key - the field name
val - the field value
Returns:
the val parameter

putAll

public void putAll(java.util.Map m)
Specified by:
putAll in interface java.util.Map<java.lang.String,java.lang.Object>
Specified by:
putAll in interface BSONObject
Overrides:
putAll in class java.util.HashMap<java.lang.String,java.lang.Object>

putAll

public void putAll(BSONObject o)
Specified by:
putAll in interface BSONObject

append

public BasicBSONObject append(java.lang.String key,
                              java.lang.Object val)
Add a key/value pair to this object

Parameters:
key - the field name
val - the field value
Returns:
the val parameter

toString

public java.lang.String toString()
Returns a JSON serialization of this object

Overrides:
toString in class java.util.AbstractMap<java.lang.String,java.lang.Object>
Returns:
JSON serialization

equals

public boolean equals(java.lang.Object o)
Specified by:
equals in interface java.util.Map<java.lang.String,java.lang.Object>
Overrides:
equals in class java.util.AbstractMap<java.lang.String,java.lang.Object>