Package com.mongodb
Class BasicDBObject
-
- <K,V>
-
- <K,V>
-
- <,>
-
- org.bson.BasicBSONObject
-
- com.mongodb.BasicDBObject
-
- All Implemented Interfaces:
,
,
<,>
,BSONObject
,Bson
- Direct Known Subclasses:
CommandResult
public class BasicDBObject extends BasicBSONObject implements DBObject, Bson
A basic implementation of BSON object that is MongoDB specific. ADBObject
can be created as follows, using this class:DBObject obj = new BasicDBObject(); obj.put( "foo", "bar" );
- See Also:
- Serialized Form
- MongoDB documentation
-
-
Constructor Summary
Constructors Constructor Description BasicDBObject()
Creates an empty object.BasicDBObject(int size)
Creates an empty objectkey, value)
Creates an object with the given key/valuemap)
Creates an object from a map.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BasicDBObject
key, val)
Add a key/value pair to this objectcopy()
Creates a new instance which is a copy of this BasicDBObject.boolean
o)
Compares two documents according to their serialized form, ignoring the order of keys.int
hashCode()
boolean
isPartialObject()
WhethermarkAsPartialObject()
was ever called only matters if you are going to upsert and do not want to risk losing fields.void
markAsPartialObject()
If this object was retrieved with only some fields (using a field filter) this method will be called to mark it as such.static BasicDBObject
json)
Parses a string in MongoDB Extended JSON format to aBasicDBObject
.static BasicDBObject
json, Decoder<BasicDBObject> decoder)
Parses a string in MongoDB Extended JSON format to aBasicDBObject
.<TDocument>
BsonDocument<TDocument> documentClass, CodecRegistry codecRegistry)
Render the filter into a BsonDocument.toJson()
Gets a JSON representation of this document using theJsonMode.STRICT
output mode, and otherwise the default settings ofJsonWriterSettings.Builder
andDBObjectCodec
.toJson(Encoder<BasicDBObject> encoder)
Gets a JSON representation of this documenttoJson(JsonWriterSettings writerSettings)
Gets a JSON representation of this documenttoJson(JsonWriterSettings writerSettings, Encoder<BasicDBObject> encoder)
Gets a JSON representation of this documenttoString()
Returns a JSON serialization of this object-
Methods inherited from class org.bson.BasicBSONObject
containsField, containsKey, get, getBoolean, getBoolean, getDate, getDate, getDouble, getDouble, getInt, getInt, getLong, getLong, getObjectId, getObjectId, getString, getString, putAll, putAll, removeField, toMap
-
Methods inherited from interface org.bson.BSONObject
containsField, containsKey, get, keySet, put, putAll, putAll, removeField, toMap
-
-
-
-
Constructor Detail
-
BasicDBObject
public BasicDBObject()
Creates an empty object.
-
BasicDBObject
public BasicDBObject(int size)
Creates an empty object- Parameters:
size
- an estimate of number of fields that will be inserted
-
BasicDBObject
public BasicDBObject( key, value)
Creates an object with the given key/value- Parameters:
key
- key under which to storevalue
- value to store
-
BasicDBObject
public BasicDBObject( map)
Creates an object from a map.- Parameters:
map
- map to convert
-
-
Method Detail
-
parse
public static json)
Parses a string in MongoDB Extended JSON format to aBasicDBObject
.- Parameters:
json
- the JSON string- Returns:
- a corresponding
BasicDBObject
object - See Also:
JsonReader
- MongoDB documentation
-
parse
public static json, Decoder<BasicDBObject> decoder)
Parses a string in MongoDB Extended JSON format to aBasicDBObject
.- Parameters:
json
- the JSON stringdecoder
- the decoder to use to decode the BasicDBObject instance- Returns:
- a corresponding
BasicDBObject
object - See Also:
JsonReader
- MongoDB documentation
-
append
public key, val)
Add a key/value pair to this object- Overrides:
append
in classBasicBSONObject
- Parameters:
key
- the field nameval
- the field value- Returns:
- this BasicDBObject with the new values added
-
isPartialObject
public boolean isPartialObject()
WhethermarkAsPartialObject()
was ever called only matters if you are going to upsert and do not want to risk losing fields.- Specified by:
isPartialObject
in interfaceDBObject
- Returns:
- true if this has been marked as a partial object
-
toJson
public toJson()
Gets a JSON representation of this document using theJsonMode.STRICT
output mode, and otherwise the default settings ofJsonWriterSettings.Builder
andDBObjectCodec
.- Returns:
- a JSON representation of this document
- Throws:
CodecConfigurationException
- if the document contains types not in the default registry- See Also:
toJson(JsonWriterSettings)
,JsonWriterSettings
-
toJson
public toJson(JsonWriterSettings writerSettings)
Gets a JSON representation of this documentWith the default
DBObjectCodec
.- Parameters:
writerSettings
- the json writer settings to use when encoding- Returns:
- a JSON representation of this document
- Throws:
CodecConfigurationException
- if the document contains types not in the default registry
-
toJson
public toJson(Encoder<BasicDBObject> encoder)
Gets a JSON representation of this documentWith the default
JsonWriterSettings
.- Parameters:
encoder
- the BasicDBObject codec instance to encode the document with- Returns:
- a JSON representation of this document
- Throws:
CodecConfigurationException
- if the registry does not contain a codec for the document values.
-
toJson
public toJson(JsonWriterSettings writerSettings, Encoder<BasicDBObject> encoder)
Gets a JSON representation of this document- Parameters:
writerSettings
- the json writer settings to use when encodingencoder
- the BasicDBObject codec instance to encode the document with- Returns:
- a JSON representation of this document
- Throws:
CodecConfigurationException
- if the registry does not contain a codec for the document values.
-
equals
public boolean equals( o)
Description copied from class:BasicBSONObject
Compares two documents according to their serialized form, ignoring the order of keys.- Specified by:
in interface
<,>
- Overrides:
equals
in classBasicBSONObject
- 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.
-
hashCode
public int hashCode()
- Specified by:
in interface
<,>
- Overrides:
hashCode
in classBasicBSONObject
-
toString
public toString()
Returns a JSON serialization of this object
The output will look like:
{"a":1, "b":["x","y","z"]}
- Overrides:
in class
<,>
- Returns:
- JSON serialization
-
markAsPartialObject
public void markAsPartialObject()
If this object was retrieved with only some fields (using a field filter) this method will be called to mark it as such.- Specified by:
markAsPartialObject
in interfaceDBObject
-
copy
public copy()
Creates a new instance which is a copy of this BasicDBObject.- Returns:
- a BasicDBObject with exactly the same values as this instance.
-
toBsonDocument
public <TDocument> <TDocument> documentClass, CodecRegistry codecRegistry)
Description copied from interface:Bson
Render the filter into a BsonDocument.- Specified by:
toBsonDocument
in interfaceBson
- Type Parameters:
TDocument
- the type of the document class- Parameters:
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 returnedBsonDocument
based on some knowledge of the document class.codecRegistry
- the codec registry. This parameter may be ignored, but it may be used to look upCodec
instances for the document class or any other related class.- Returns:
- the BsonDocument
-
-