Package com.mongodb

Class BasicDBObjectBuilder

java.lang.Object
com.mongodb.BasicDBObjectBuilder
public class BasicDBObjectBuilder extends Object

Utility for building complex objects. For example:

   BasicDBObjectBuilder.start().add( "name" , "eliot").add("number" , 17).get()

  • Constructor Details

    • BasicDBObjectBuilder

      public BasicDBObjectBuilder()
      Creates a builder intialized with an empty document.

  • Method Details

    • start

      public static BasicDBObjectBuilder start()
      Creates a builder intialized with an empty document.
      Returns:
      The new empty builder

    • start

      public static BasicDBObjectBuilder start(String key, Object val)
      Creates a builder initialized with the given key/value.
      Parameters:
      key - The field name
      val - The value
      Returns:
      the new builder

    • start

      public static BasicDBObjectBuilder start(Map documentAsMap)
      Creates an object builder from an existing map of key value pairs.
      Parameters:
      documentAsMap - a document in Map form.
      Returns:
      the new builder

    • append

      public BasicDBObjectBuilder append(String key, Object val)
      Appends the key/value to the active object
      Parameters:
      key - the field name
      val - the value of the field
      Returns:
      this so calls can be chained

    • add

      public BasicDBObjectBuilder add(String key, Object val)
      Same as append
      Parameters:
      key - the field name
      val - the value of the field
      Returns:
      this so calls can be chained
      See Also:

    • push

      public BasicDBObjectBuilder push(String key)
      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

      public BasicDBObjectBuilder pop()
      Pops the active object, which means that the parent object becomes active
      Returns:
      this so calls can be chained

    • get

      public DBObject 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