Package com.mongodb
Class BasicDBObjectBuilder
java.lang.Object
com.mongodb.BasicDBObjectBuilder
Utility for building complex objects. For example:
BasicDBObjectBuilder.start().add( "name" , "eliot").add("number" , 17).get()
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionSame as appendAppends the key/value to the active objectget()
Gets the top level document.boolean
isEmpty()
Returns true if no key/value was inserted into the top level document.pop()
Pops the active object, which means that the parent object becomes activeCreates a new empty object and inserts it into the current object with the given key.static BasicDBObjectBuilder
start()
Creates a builder intialized with an empty document.static BasicDBObjectBuilder
Creates a builder initialized with the given key/value.static BasicDBObjectBuilder
Creates an object builder from an existing map of key value pairs.
-
Constructor Details
-
BasicDBObjectBuilder
public BasicDBObjectBuilder()Creates a builder intialized with an empty document.
-
-
Method Details
-
start
Creates a builder intialized with an empty document.- Returns:
- The new empty builder
-
start
Creates a builder initialized with the given key/value.- Parameters:
key
- The field nameval
- The value- Returns:
- the new builder
-
start
Creates an object builder from an existing map of key value pairs.- Parameters:
documentAsMap
- a document in Map form.- Returns:
- the new builder
-
append
Appends the key/value to the active object- Parameters:
key
- the field nameval
- the value of the field- Returns:
this
so calls can be chained
-
add
Same as append- Parameters:
key
- the field nameval
- the value of the field- Returns:
this
so calls can be chained- See Also:
-
push
Creates a new empty object and inserts it into the current object with the given key. The new child object becomes the active one.- Parameters:
key
- the field name- Returns:
this
so calls can be chained
-
pop
Pops the active object, which means that the parent object becomes active- Returns:
this
so calls can be chained
-
get
Gets the top level document.- Returns:
- The base object
-
isEmpty
public boolean isEmpty()Returns true if no key/value was inserted into the top level document.- Returns:
- true if empty
-