DocumentBuilder (mongodb-async-driver 1.0.2 API)

All Superinterfaces:

Builder, DocumentAssignable

All Known Implementing Classes:

AggregationGroupId.Builder, DocumentBuilderImpl
```
public interface DocumentBuilder
extends Builder, DocumentAssignable
```
Interface for a builder used to construct a BSON document.

API Notice:

This interface is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2011-2012, Allanbank Consulting, Inc., All Rights Reserved

Method Summary

Methods
Modifier and Type	Method and Description
`DocumentBuilder`	`add(ElementAssignable element)` Adds a pre-built element to the document.
`DocumentBuilder`	`add(String name, boolean value)` Adds a boolean element.
`DocumentBuilder`	`add(String name, byte[] data)` Adds a binary element using sub-type zero (the default).
`DocumentBuilder`	`add(String name, byte subType, byte[] data)` Adds a binary element.
`DocumentBuilder`	`add(String name, Date timestamp)` Adds a timestamp element.
`DocumentBuilder`	`add(String name, DocumentAssignable document)` Adds a pre-constructed document to the array.
`DocumentBuilder`	`add(String name, double value)` Adds a double element.
`DocumentBuilder`	`add(String name, int value)` Adds a integer (32-bit signed) element.
`DocumentBuilder`	`add(String name, long value)` Adds a long (64-bit signed) element.
`DocumentBuilder`	`add(String name, ObjectId id)` Adds an ObjectId element.
`DocumentBuilder`	`add(String name, Pattern pattern)` Adds an ObjectId element.
`DocumentBuilder`	`add(String name, String value)` Adds a string element.
`DocumentBuilder`	`add(String name, String databaseName, String collectionName, ObjectId id)` Deprecated. See BSON specification.
`DocumentBuilder`	`addBinary(String name, byte[] data)` Adds a binary element using sub-type zero (the default).
`DocumentBuilder`	`addBinary(String name, byte subType, byte[] data)` Adds a binary element using sub-type zero (the default).
`DocumentBuilder`	`addBoolean(String name, boolean value)` Adds a boolean element.
`DocumentBuilder`	`addDBPointer(String name, String databaseName, String collectionName, ObjectId id)` Deprecated. See BSON specification.
`DocumentBuilder`	`addDocument(String name, DocumentAssignable value)` Adds a pre-built document element.
`DocumentBuilder`	`addDouble(String name, double value)` Adds a double element.
`DocumentBuilder`	`addInteger(String name, int value)` Adds a integer (32-bit signed) element.
`DocumentBuilder`	`addJavaScript(String name, String code)` Adds a JavaScript element.
`DocumentBuilder`	`addJavaScript(String name, String code, DocumentAssignable scope)` Adds a JavaScript with Scope element.
`DocumentBuilder`	`addLong(String name, long value)` Adds a long (64-bit signed) element.
`DocumentBuilder`	`addMaxKey(String name)` Adds a minimum key value element.
`DocumentBuilder`	`addMinKey(String name)` Adds a minimum key value element.
`DocumentBuilder`	`addMongoTimestamp(String name, long value)` Adds a MongoDB Timestamp element.
`DocumentBuilder`	`addNull(String name)` Adds a `null` valued element.
`DocumentBuilder`	`addObjectId(String name, ObjectId id)` Adds an ObjectId element.
`DocumentBuilder`	`addRegularExpression(String name, Pattern pattern)` Adds a regular expression element.
`DocumentBuilder`	`addRegularExpression(String name, String pattern, String options)` Adds a regular expression element.
`DocumentBuilder`	`addString(String name, String value)` Adds a string element.
`DocumentBuilder`	`addSymbol(String name, String symbol)` Adds a symbol element.
`DocumentBuilder`	`addTimestamp(String name, long timestamp)` Adds a timestamp element.
`Document`	`build()` Returns the `Document` being constructed.
`DocumentBuilder`	`push(String name)` Pushes a context for constructing a sub-document.
`ArrayBuilder`	`pushArray(String name)` Pushes a context for constructing a sub-array.
`DocumentBuilder`	`reset()` Resets the builder back to an empty state.

Methods inherited from interface com.allanbank.mongodb.bson.builder.Builder
pop

Methods inherited from interface com.allanbank.mongodb.bson.DocumentAssignable
asDocument

- Method Detail
  - add
```
DocumentBuilder add(ElementAssignable element)
```
    Adds a pre-built element to the document.
    
    Parameters:
    element - The element to add.
    
    Returns:
    This DocumentBuilder for method chaining.
  - add
```
DocumentBuilder add(String name,
                  boolean value)
```
    Adds a boolean element.
    This is a equivalent to addBoolean(String,boolean) but less verbose.
    
    Parameters:
    name - The name of the element.
    value - The boolean value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - add
```
DocumentBuilder add(String name,
                  byte subType,
                  byte[] data)
```
    Adds a binary element.
    This is a equivalent to addBinary(String,byte, byte[]) but less verbose.
    
    Parameters:
    name - The name of the element.
    subType - The sub-type for the binary data.
    data - The binary value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - add
```
DocumentBuilder add(String name,
                  byte[] data)
```
    Adds a binary element using sub-type zero (the default).
    This is a equivalent to addBinary(String,byte[]) but less verbose.
    
    Parameters:
    name - The name of the element.
    data - The binary value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - add
```
DocumentBuilder add(String name,
                  Date timestamp)
```
    Adds a timestamp element. The timestamp is the number of milliseconds since the Unix epoch.
    This is a equivalent to addTimeStamp(timestamp.getTime()) but less verbose.
    
    Parameters:
    name - The name of the element.
    timestamp - The number of milliseconds since the Unix epoch.
    
    Returns:
    This DocumentBuilder for method chaining.
  - add
```
DocumentBuilder add(String name,
                  DocumentAssignable document)
```
    Adds a pre-constructed document to the array.
    This is a equivalent to addDocument(String,DocumentAssignable) but less verbose.
    
    Parameters:
    name - The name of the element.
    document - The document to add to the array.
    
    Returns:
    This DocumentBuilder for method chaining.
  - add
```
DocumentBuilder add(String name,
                  double value)
```
    Adds a double element.
    This is a equivalent to addDouble(String,double) but less verbose.
    
    Parameters:
    name - The name of the element.
    value - The double value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - add
```
DocumentBuilder add(String name,
                  int value)
```
    Adds a integer (32-bit signed) element.
    This is a equivalent to addInteger(String,int) but less verbose.
    
    Parameters:
    name - The name of the element.
    value - The integer value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - add
```
DocumentBuilder add(String name,
                  long value)
```
    Adds a long (64-bit signed) element.
    This is a equivalent to addLong(String,long) but less verbose.
    
    Parameters:
    name - The name of the element.
    value - The long value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - add
```
DocumentBuilder add(String name,
                  ObjectId id)
```
    Adds an ObjectId element.
    This is a equivalent to addObjectId(String,ObjectId) but less verbose.
    
    Parameters:
    name - The name of the element.
    id - The ObjectId to add.
    
    Returns:
    This DocumentBuilder for method chaining.
  - add
```
DocumentBuilder add(String name,
                  Pattern pattern)
```
    Adds an ObjectId element.
    This is a equivalent to addRegularExpression(String,Pattern) but less verbose.
    
    Parameters:
    name - The name of the element.
    pattern - The pattern for the regular expression.
    
    Returns:
    This DocumentBuilder for method chaining.
  - add
```
DocumentBuilder add(String name,
                  String value)
```
    Adds a string element.
    This is a equivalent to addString(String,String) but less verbose.
    
    Parameters:
    name - The name of the element.
    value - The string value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - add
```
@Deprecated
DocumentBuilder add(String name,
                             String databaseName,
                             String collectionName,
                             ObjectId id)
```
    Deprecated. See BSON specification.
    
    Adds a deprecated DBPointer element.
    This is a equivalent to addDBPointer(String,String, String, ObjectId) but less verbose.
    
    Parameters:
    name - The name of the element.
    databaseName - The name of the database containing the document.
    collectionName - The name of the collection containing the document.
    id - The id for the document.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addBinary
```
DocumentBuilder addBinary(String name,
                        byte subType,
                        byte[] data)
```
    Adds a binary element using sub-type zero (the default).
    
    Parameters:
    name - The name of the element.
    subType - The sub-type for the binary data.
    data - The binary value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addBinary
```
DocumentBuilder addBinary(String name,
                        byte[] data)
```
    Adds a binary element using sub-type zero (the default).
    
    Parameters:
    name - The name of the element.
    data - The binary value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addBoolean
```
DocumentBuilder addBoolean(String name,
                         boolean value)
```
    Adds a boolean element.
    
    Parameters:
    name - The name of the element.
    value - The boolean value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addDBPointer
```
@Deprecated
DocumentBuilder addDBPointer(String name,
                                      String databaseName,
                                      String collectionName,
                                      ObjectId id)
```
    Deprecated. See BSON specification.
    
    Adds a deprecated DBPointer element.
    
    Parameters:
    name - The name of the element.
    databaseName - The name of the database containing the document.
    collectionName - The name of the collection containing the document.
    id - The id for the document.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addDocument
```
DocumentBuilder addDocument(String name,
                          DocumentAssignable value)
```
    Adds a pre-built document element. Can also push(String) a sub document.
    
    Parameters:
    name - The name of the element.
    value - The document value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addDouble
```
DocumentBuilder addDouble(String name,
                        double value)
```
    Adds a double element.
    
    Parameters:
    name - The name of the element.
    value - The double value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addInteger
```
DocumentBuilder addInteger(String name,
                         int value)
```
    Adds a integer (32-bit signed) element.
    
    Parameters:
    name - The name of the element.
    value - The integer value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addJavaScript
```
DocumentBuilder addJavaScript(String name,
                            String code)
```
    Adds a JavaScript element.
    
    Parameters:
    name - The name of the element.
    code - The java script code.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addJavaScript
```
DocumentBuilder addJavaScript(String name,
                            String code,
                            DocumentAssignable scope)
```
    Adds a JavaScript with Scope element.
    
    Parameters:
    name - The name of the element.
    code - The java script code.
    scope - The scope for the JacaScript code.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addLong
```
DocumentBuilder addLong(String name,
                      long value)
```
    Adds a long (64-bit signed) element.
    
    Parameters:
    name - The name of the element.
    value - The long value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addMaxKey
```
DocumentBuilder addMaxKey(String name)
```
    Adds a minimum key value element. Used as an absolute upper bounds.
    
    Parameters:
    name - The name of the element.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addMinKey
```
DocumentBuilder addMinKey(String name)
```
    Adds a minimum key value element. Used as an absolute lower bounds.
    
    Parameters:
    name - The name of the element.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addMongoTimestamp
```
DocumentBuilder addMongoTimestamp(String name,
                                long value)
```
    Adds a MongoDB Timestamp element.
    
    Parameters:
    name - The name of the element.
    value - The mongoDB timstamp value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addNull
```
DocumentBuilder addNull(String name)
```
    Adds a null valued element.
    
    Parameters:
    name - The name of the element.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addObjectId
```
DocumentBuilder addObjectId(String name,
                          ObjectId id)
```
    Adds an ObjectId element.
    
    Parameters:
    name - The name of the element.
    id - The ObjectId to add.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addRegularExpression
```
DocumentBuilder addRegularExpression(String name,
                                   Pattern pattern)
```
    Adds a regular expression element.
    
    Parameters:
    name - The name of the element.
    pattern - The pattern for the regular expression.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addRegularExpression
```
DocumentBuilder addRegularExpression(String name,
                                   String pattern,
                                   String options)
```
    Adds a regular expression element.
    
    Parameters:
    name - The name of the element.
    pattern - The pattern for the regular expression.
    options - The regular expression options. See the BSON specification for details.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addString
```
DocumentBuilder addString(String name,
                        String value)
```
    Adds a string element.
    
    Parameters:
    name - The name of the element.
    value - The string value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addSymbol
```
DocumentBuilder addSymbol(String name,
                        String symbol)
```
    Adds a symbol element.
    
    Parameters:
    name - The name of the element.
    symbol - The symbol value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addTimestamp
```
DocumentBuilder addTimestamp(String name,
                           long timestamp)
```
    Adds a timestamp element. The timestamp is the number of milliseconds since the Unix epoch.
    
    Parameters:
    name - The name of the element.
    timestamp - The number of milliseconds since the Unix epoch.
    
    Returns:
    This DocumentBuilder for method chaining.
  - build
```
Document build()
```
    Returns the Document being constructed.
    
    Returns:
    The constructed Document.
  - push
```
DocumentBuilder push(String name)
```
    Pushes a context for constructing a sub-document.
    
    Parameters:
    name - The name of the sub-document.
    
    Returns:
    A DocumentBuilder for constructing the sub-document.
  - pushArray
```
ArrayBuilder pushArray(String name)
```
    Pushes a context for constructing a sub-array.
    
    Parameters:
    name - The name of the sub-array.
    
    Returns:
    A ArrayBuilder for constructing the sub-array.
  - reset
```
DocumentBuilder reset()
```
    Resets the builder back to an empty state.
    Overridden to return an DocumentBuilder instance.
    
    Specified by:
    
    reset in interface Builder
    
    Returns:
    This builder for method call chaining.

Interface DocumentBuilder

Method Summary

Methods inherited from interface com.allanbank.mongodb.bson.builder.Builder

Methods inherited from interface com.allanbank.mongodb.bson.DocumentAssignable

Method Detail

add

add

add

add

add

add

add

add

add

add

add

add

add

addBinary

addBinary

addBoolean

addDBPointer

addDocument

addDouble

addInteger

addJavaScript

addJavaScript

addLong

addMaxKey

addMinKey

addMongoTimestamp

addNull

addObjectId

addRegularExpression

addRegularExpression

addString

addSymbol

addTimestamp

build

push

pushArray

reset