DocumentBuilderImpl (mongodb-async-driver 1.0.2 API)

java.lang.Object
- com.allanbank.mongodb.bson.builder.impl.AbstractBuilder
- - com.allanbank.mongodb.bson.builder.impl.DocumentBuilderImpl

All Implemented Interfaces:

Builder, DocumentBuilder, DocumentAssignable

Direct Known Subclasses:

AggregationGroupId.Builder
```
public class DocumentBuilderImpl
extends AbstractBuilder
implements DocumentBuilder
```
A builder for BSON documents.

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

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

Nested Class Summary
- Nested classes/interfaces inherited from class com.allanbank.mongodb.bson.builder.impl.AbstractBuilder
  AbstractBuilder.BuilderElement

Field Summary
- Fields inherited from class com.allanbank.mongodb.bson.builder.impl.AbstractBuilder
  ASSERTIONS_ENABLED, BUILDER_ELEMENT_CLASS, myElements

Constructor Summary

Constructors
Constructor and Description

DocumentBuilderImpl()
Creates a new builder.

DocumentBuilderImpl(AbstractBuilder outerScope)
Creates a new builder.

Constructors
Constructor and Description
`DocumentBuilderImpl()` Creates a new builder.
`DocumentBuilderImpl(AbstractBuilder outerScope)` Creates a new builder.

Method Summary

Methods
Modifier and Type	Method and Description
`DocumentBuilder`	`add(ElementAssignable elementRef)` 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.
`DocumentBuilder`	`addBinary(String name, byte[] value)` Adds a binary element using sub-type zero (the default).
`DocumentBuilder`	`addBinary(String name, byte subType, byte[] value)` 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.
`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`	`asDocument()` Converts the object into a document.
`Document`	`build()` Returns the `Document` being constructed.
`protected Element`	`build(String name)` Constructs the final form of the element 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 class com.allanbank.mongodb.bson.builder.impl.AbstractBuilder
doPush, doPushArray, pop, subElements

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

- Constructor Detail
  - DocumentBuilderImpl
```
public DocumentBuilderImpl()
```
    Creates a new builder.
  - DocumentBuilderImpl
```
public DocumentBuilderImpl(AbstractBuilder outerScope)
```
    Creates a new builder.
    
    Parameters:
    outerScope - The outer document scope.
- Method Detail
  - add
```
public DocumentBuilder add(ElementAssignable elementRef)
```
    Adds a pre-built element to the document.
    
    Specified by:
    
    add in interface DocumentBuilder
    
    Parameters:
    elementRef - The element to add.
    
    Returns:
    This DocumentBuilder for method chaining.
  - add
```
public DocumentBuilder add(String name,
                  boolean value)
```
    Adds a boolean element.
    This is a equivalent to DocumentBuilder.addBoolean(String,boolean) but less verbose.
    
    Specified by:
    
    add in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    value - The boolean value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - add
```
public DocumentBuilder add(String name,
                  byte subType,
                  byte[] data)
```
    Adds a binary element.
    This is a equivalent to DocumentBuilder.addBinary(String,byte, byte[]) but less verbose.
    
    Specified by:
    
    add in interface DocumentBuilder
    
    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
```
public DocumentBuilder add(String name,
                  byte[] data)
```
    Adds a binary element using sub-type zero (the default).
    This is a equivalent to DocumentBuilder.addBinary(String,byte[]) but less verbose.
    
    Specified by:
    
    add in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    data - The binary value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - add
```
public 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.
    
    Specified by:
    
    add in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    timestamp - The number of milliseconds since the Unix epoch.
    
    Returns:
    This DocumentBuilder for method chaining.
  - add
```
public DocumentBuilder add(String name,
                  DocumentAssignable document)
```
    Adds a pre-constructed document to the array.
    This is a equivalent to DocumentBuilder.addDocument(String,DocumentAssignable) but less verbose.
    
    Specified by:
    
    add in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    document - The document to add to the array.
    
    Returns:
    This DocumentBuilder for method chaining.
  - add
```
public DocumentBuilder add(String name,
                  double value)
```
    Adds a double element.
    This is a equivalent to DocumentBuilder.addDouble(String,double) but less verbose.
    
    Specified by:
    
    add in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    value - The double value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - add
```
public DocumentBuilder add(String name,
                  int value)
```
    Adds a integer (32-bit signed) element.
    This is a equivalent to DocumentBuilder.addInteger(String,int) but less verbose.
    
    Specified by:
    
    add in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    value - The integer value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - add
```
public DocumentBuilder add(String name,
                  long value)
```
    Adds a long (64-bit signed) element.
    This is a equivalent to DocumentBuilder.addLong(String,long) but less verbose.
    
    Specified by:
    
    add in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    value - The long value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - add
```
public DocumentBuilder add(String name,
                  ObjectId id)
```
    Adds an ObjectId element.
    This is a equivalent to DocumentBuilder.addObjectId(String,ObjectId) but less verbose.
    
    Specified by:
    
    add in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    id - The ObjectId to add.
    
    Returns:
    This DocumentBuilder for method chaining.
  - add
```
public DocumentBuilder add(String name,
                  Pattern pattern)
```
    Adds an ObjectId element.
    This is a equivalent to DocumentBuilder.addRegularExpression(String,Pattern) but less verbose.
    
    Specified by:
    
    add in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    pattern - The pattern for the regular expression.
    
    Returns:
    This DocumentBuilder for method chaining.
  - add
```
public DocumentBuilder add(String name,
                  String value)
```
    Adds a string element.
    This is a equivalent to DocumentBuilder.addString(String,String) but less verbose.
    
    Specified by:
    
    add in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    value - The string value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - add
```
@Deprecated
public DocumentBuilder add(String name,
                             String databaseName,
                             String collectionName,
                             ObjectId id)
```
    Deprecated.
    
    Adds a deprecated DBPointer element.
    This is a equivalent to DocumentBuilder.addDBPointer(String,String, String, ObjectId) but less verbose.
    
    Specified by:
    
    add in interface DocumentBuilder
    
    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
```
public DocumentBuilder addBinary(String name,
                        byte subType,
                        byte[] value)
```
    Adds a binary element using sub-type zero (the default).
    
    Specified by:
    
    addBinary in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    subType - The sub-type for the binary data.
    value - The binary value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addBinary
```
public DocumentBuilder addBinary(String name,
                        byte[] value)
```
    Adds a binary element using sub-type zero (the default).
    
    Specified by:
    
    addBinary in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    value - The binary value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addBoolean
```
public DocumentBuilder addBoolean(String name,
                         boolean value)
```
    Adds a boolean element.
    
    Specified by:
    
    addBoolean in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    value - The boolean value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addDBPointer
```
@Deprecated
public DocumentBuilder addDBPointer(String name,
                                      String databaseName,
                                      String collectionName,
                                      ObjectId id)
```
    Deprecated.
    
    Adds a deprecated DBPointer element.
    
    Specified by:
    
    addDBPointer in interface DocumentBuilder
    
    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
```
public DocumentBuilder addDocument(String name,
                          DocumentAssignable value)
```
    Adds a pre-built document element. Can also DocumentBuilder.push(String) a sub document.
    
    Specified by:
    
    addDocument in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    value - The document value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addDouble
```
public DocumentBuilder addDouble(String name,
                        double value)
```
    Adds a double element.
    
    Specified by:
    
    addDouble in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    value - The double value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addInteger
```
public DocumentBuilder addInteger(String name,
                         int value)
```
    Adds a integer (32-bit signed) element.
    
    Specified by:
    
    addInteger in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    value - The integer value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addJavaScript
```
public DocumentBuilder addJavaScript(String name,
                            String code)
```
    Adds a JavaScript element.
    
    Specified by:
    
    addJavaScript in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    code - The java script code.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addJavaScript
```
public DocumentBuilder addJavaScript(String name,
                            String code,
                            DocumentAssignable scope)
```
    Adds a JavaScript with Scope element.
    
    Specified by:
    
    addJavaScript in interface DocumentBuilder
    
    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
```
public DocumentBuilder addLong(String name,
                      long value)
```
    Adds a long (64-bit signed) element.
    
    Specified by:
    
    addLong in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    value - The long value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addMaxKey
```
public DocumentBuilder addMaxKey(String name)
```
    Adds a minimum key value element. Used as an absolute upper bounds.
    
    Specified by:
    
    addMaxKey in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addMinKey
```
public DocumentBuilder addMinKey(String name)
```
    Adds a minimum key value element. Used as an absolute lower bounds.
    
    Specified by:
    
    addMinKey in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addMongoTimestamp
```
public DocumentBuilder addMongoTimestamp(String name,
                                long value)
```
    Adds a MongoDB Timestamp element.
    
    Specified by:
    
    addMongoTimestamp in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    value - The mongoDB timstamp value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addNull
```
public DocumentBuilder addNull(String name)
```
    Adds a null valued element.
    
    Specified by:
    
    addNull in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addObjectId
```
public DocumentBuilder addObjectId(String name,
                          ObjectId id)
```
    Adds an ObjectId element.
    
    Specified by:
    
    addObjectId in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    id - The ObjectId to add.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addRegularExpression
```
public DocumentBuilder addRegularExpression(String name,
                                   Pattern pattern)
```
    Adds a regular expression element.
    
    Specified by:
    
    addRegularExpression in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    pattern - The pattern for the regular expression.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addRegularExpression
```
public DocumentBuilder addRegularExpression(String name,
                                   String pattern,
                                   String options)
```
    Adds a regular expression element.
    
    Specified by:
    
    addRegularExpression in interface DocumentBuilder
    
    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
```
public DocumentBuilder addString(String name,
                        String value)
```
    Adds a string element.
    
    Specified by:
    
    addString in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    value - The string value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addSymbol
```
public DocumentBuilder addSymbol(String name,
                        String symbol)
```
    Adds a symbol element.
    
    Specified by:
    
    addSymbol in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    symbol - The symbol value.
    
    Returns:
    This DocumentBuilder for method chaining.
  - addTimestamp
```
public DocumentBuilder addTimestamp(String name,
                           long timestamp)
```
    Adds a timestamp element. The timestamp is the number of milliseconds since the Unix epoch.
    
    Specified by:
    
    addTimestamp in interface DocumentBuilder
    
    Parameters:
    name - The name of the element.
    timestamp - The number of milliseconds since the Unix epoch.
    
    Returns:
    This DocumentBuilder for method chaining.
  - asDocument
```
public Document asDocument()
```
    Converts the object into a document.
    Returns the result of build().
    
    Specified by:
    
    asDocument in interface DocumentAssignable
    
    Returns:
    The object as a Document.
    See Also:
    build()
  - build
```
public Document build()
```
    Returns the Document being constructed.
    
    Specified by:
    
    build in interface DocumentBuilder
    
    Returns:
    The constructed Document.
  - push
```
public DocumentBuilder push(String name)
```
    Pushes a context for constructing a sub-document.
    
    Specified by:
    
    push in interface DocumentBuilder
    
    Parameters:
    name - The name of the sub-document.
    
    Returns:
    A DocumentBuilder for constructing the sub-document.
  - pushArray
```
public ArrayBuilder pushArray(String name)
```
    Pushes a context for constructing a sub-array.
    
    Specified by:
    
    pushArray in interface DocumentBuilder
    
    Parameters:
    name - The name of the sub-array.
    
    Returns:
    A ArrayBuilder for constructing the sub-array.
  - reset
```
public DocumentBuilder reset()
```
    Resets the builder back to an empty state.
    
    Specified by:
    
    reset in interface Builder
    
    Specified by:
    
    reset in interface DocumentBuilder
    
    Overrides:
    
    reset in class AbstractBuilder
    
    Returns:
    This builder for method call chaining.
  - build
```
protected Element build(String name)
```
    Constructs the final form of the element being constructed.
    Overridden to return an DocumentElement.
    
    Specified by:
    
    build in class AbstractBuilder
    
    Parameters:
    name - The name of the element.
    
    Returns:
    The Element constructed by the builder.

Class DocumentBuilderImpl

Nested Class Summary

Nested classes/interfaces inherited from class com.allanbank.mongodb.bson.builder.impl.AbstractBuilder

Field Summary

Fields inherited from class com.allanbank.mongodb.bson.builder.impl.AbstractBuilder

Constructor Summary

Method Summary

Methods inherited from class com.allanbank.mongodb.bson.builder.impl.AbstractBuilder

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentBuilderImpl

DocumentBuilderImpl

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

asDocument

build

push

pushArray

reset

build