| Package | Description | 
|---|---|
| com.allanbank.mongodb.bson.builder | 
 Provides the interfaces for builders to aid in constructing BSON 
  
Documents. | 
| com.allanbank.mongodb.bson.builder.impl | 
 Provides the implementations for builders to aid in constructing BSON 
  
Documents. | 
| com.allanbank.mongodb.builder | 
 Provides domain classes and builders for queries and the common MongoDB commands. 
 | 
| com.allanbank.mongodb.client | 
 Provides implementations of the main client interfaces and classes to translate the 
  
Reply(s) from the server. | 
| Modifier and Type | Method and Description | 
|---|---|
DocumentBuilder | 
DocumentBuilder.add(ElementAssignable element)
Adds a pre-built element to the document. 
 | 
DocumentBuilder | 
DocumentBuilder.add(String name,
   boolean value)
Adds a boolean element. 
 | 
DocumentBuilder | 
DocumentBuilder.add(String name,
   byte[] data)
Adds a binary element using sub-type zero (the default). 
 | 
DocumentBuilder | 
DocumentBuilder.add(String name,
   byte subType,
   byte[] data)
Adds a binary element. 
 | 
DocumentBuilder | 
DocumentBuilder.add(String name,
   Date timestamp)
Adds a timestamp element. 
 | 
DocumentBuilder | 
DocumentBuilder.add(String name,
   DocumentAssignable document)
Adds a pre-constructed document to the array. 
 | 
DocumentBuilder | 
DocumentBuilder.add(String name,
   double value)
Adds a double element. 
 | 
DocumentBuilder | 
DocumentBuilder.add(String name,
   int value)
Adds a integer (32-bit signed) element. 
 | 
DocumentBuilder | 
DocumentBuilder.add(String name,
   long value)
Adds a long (64-bit signed) element. 
 | 
DocumentBuilder | 
DocumentBuilder.add(String name,
   Object value)
Adds the value to the document after trying to coerce the value into the
 best possible element type. 
 | 
DocumentBuilder | 
DocumentBuilder.add(String name,
   ObjectId id)
Adds an ObjectId element. 
 | 
DocumentBuilder | 
DocumentBuilder.add(String name,
   Pattern pattern)
Adds an ObjectId element. 
 | 
DocumentBuilder | 
DocumentBuilder.add(String name,
   String value)
Adds a string element. 
 | 
DocumentBuilder | 
DocumentBuilder.add(String name,
   String databaseName,
   String collectionName,
   ObjectId id)
Deprecated. 
 
See BSON specification. 
 | 
DocumentBuilder | 
DocumentBuilder.add(String name,
   UUID uuid)
Adds a (sub-type 4)  
UUID binary element. | 
DocumentBuilder | 
DocumentBuilder.addBinary(String name,
         byte[] data)
Adds a binary element using sub-type zero (the default). 
 | 
DocumentBuilder | 
DocumentBuilder.addBinary(String name,
         byte subType,
         byte[] data)
Adds a binary element using sub-type zero (the default). 
 | 
DocumentBuilder | 
DocumentBuilder.addBoolean(String name,
          boolean value)
Adds a boolean element. 
 | 
DocumentBuilder | 
DocumentBuilder.addDBPointer(String name,
            String databaseName,
            String collectionName,
            ObjectId id)
Deprecated. 
 
See BSON specification. 
 | 
DocumentBuilder | 
DocumentBuilder.addDocument(String name,
           DocumentAssignable value)
Adds a pre-built document element. 
 | 
DocumentBuilder | 
DocumentBuilder.addDouble(String name,
         double value)
Adds a double element. 
 | 
DocumentBuilder | 
DocumentBuilder.addInteger(String name,
          int value)
Adds a integer (32-bit signed) element. 
 | 
DocumentBuilder | 
DocumentBuilder.addJavaScript(String name,
             String code)
Adds a JavaScript element. 
 | 
DocumentBuilder | 
DocumentBuilder.addJavaScript(String name,
             String code,
             DocumentAssignable scope)
Adds a JavaScript with Scope element. 
 | 
DocumentBuilder | 
DocumentBuilder.addLegacyUuid(String name,
             UUID uuid)
Adds a legacy (sub-type 3)  
UUID binary element. | 
DocumentBuilder | 
DocumentBuilder.addLong(String name,
       long value)
Adds a long (64-bit signed) element. 
 | 
DocumentBuilder | 
DocumentBuilder.addMaxKey(String name)
Adds a minimum key value element. 
 | 
DocumentBuilder | 
DocumentBuilder.addMinKey(String name)
Adds a minimum key value element. 
 | 
DocumentBuilder | 
DocumentBuilder.addMongoTimestamp(String name,
                 long value)
Adds a MongoDB Timestamp element. 
 | 
DocumentBuilder | 
DocumentBuilder.addNull(String name)
Adds a  
null valued element. | 
DocumentBuilder | 
DocumentBuilder.addObjectId(String name,
           ObjectId id)
Adds an ObjectId element. 
 | 
DocumentBuilder | 
DocumentBuilder.addRegularExpression(String name,
                    Pattern pattern)
Adds a regular expression element. 
 | 
DocumentBuilder | 
DocumentBuilder.addRegularExpression(String name,
                    String pattern,
                    String options)
Adds a regular expression element. 
 | 
DocumentBuilder | 
DocumentBuilder.addString(String name,
         String value)
Adds a string element. 
 | 
DocumentBuilder | 
DocumentBuilder.addSymbol(String name,
         String symbol)
Adds a symbol element. 
 | 
DocumentBuilder | 
DocumentBuilder.addTimestamp(String name,
            long timestamp)
Adds a timestamp element. 
 | 
DocumentBuilder | 
DocumentBuilder.addUuid(String name,
       UUID uuid)
Adds a (sub-type 4)  
UUID binary element. | 
DocumentBuilder | 
ArrayBuilder.push()
Pushes a context for constructing a sub-document. 
 | 
DocumentBuilder | 
DocumentBuilder.push(String name)
Pushes a context for constructing a sub-document. 
 | 
DocumentBuilder | 
DocumentBuilder.remove(String name)
Removes all  
Elements that have the provided name from the
 document being built. | 
DocumentBuilder | 
DocumentBuilder.reset()
Resets the builder back to an empty state. 
 | 
static DocumentBuilder | 
BuilderFactory.start()
Creates a new  
DocumentBuilder. | 
static DocumentBuilder | 
BuilderFactory.start(DocumentAssignable seedDocument)
Creates a new  
DocumentBuilder to append more elements to an
 existing document. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
DocumentBuilderImpl
A builder for BSON documents. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
DocumentBuilder | 
DocumentBuilderImpl.add(ElementAssignable elementRef)
Adds a pre-built element to the document. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.add(String name,
   boolean value)
Adds a boolean element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.add(String name,
   byte[] data)
Adds a binary element using sub-type zero (the default). 
 | 
DocumentBuilder | 
DocumentBuilderImpl.add(String name,
   byte subType,
   byte[] data)
Adds a binary element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.add(String name,
   Date timestamp)
Adds a timestamp element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.add(String name,
   DocumentAssignable document)
Adds a pre-constructed document to the array. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.add(String name,
   double value)
Adds a double element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.add(String name,
   int value)
Adds a integer (32-bit signed) element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.add(String name,
   long value)
Adds a long (64-bit signed) element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.add(String name,
   Object value)
Adds the value to the document after trying to coerce the value into the
 best possible element type. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.add(String name,
   ObjectId id)
Adds an ObjectId element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.add(String name,
   Pattern pattern)
Adds an ObjectId element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.add(String name,
   String value)
Adds a string element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.add(String name,
   String databaseName,
   String collectionName,
   ObjectId id)
Deprecated.  
 | 
DocumentBuilder | 
DocumentBuilderImpl.add(String name,
   UUID uuid)
Adds a (sub-type 4)  
UUID binary element. | 
DocumentBuilder | 
DocumentBuilderImpl.addBinary(String name,
         byte[] value)
Adds a binary element using sub-type zero (the default). 
 | 
DocumentBuilder | 
DocumentBuilderImpl.addBinary(String name,
         byte subType,
         byte[] value)
Adds a binary element using sub-type zero (the default). 
 | 
DocumentBuilder | 
DocumentBuilderImpl.addBoolean(String name,
          boolean value)
Adds a boolean element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.addDBPointer(String name,
            String databaseName,
            String collectionName,
            ObjectId id)
Deprecated.  
 | 
DocumentBuilder | 
DocumentBuilderImpl.addDocument(String name,
           DocumentAssignable value)
Adds a pre-built document element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.addDouble(String name,
         double value)
Adds a double element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.addInteger(String name,
          int value)
Adds a integer (32-bit signed) element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.addJavaScript(String name,
             String code)
Adds a JavaScript element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.addJavaScript(String name,
             String code,
             DocumentAssignable scope)
Adds a JavaScript with Scope element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.addLegacyUuid(String name,
             UUID uuid)
Adds a legacy (sub-type 3)  
UUID binary element. | 
DocumentBuilder | 
DocumentBuilderImpl.addLong(String name,
       long value)
Adds a long (64-bit signed) element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.addMaxKey(String name)
Adds a minimum key value element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.addMinKey(String name)
Adds a minimum key value element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.addMongoTimestamp(String name,
                 long value)
Adds a MongoDB Timestamp element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.addNull(String name)
Adds a  
null valued element. | 
DocumentBuilder | 
DocumentBuilderImpl.addObjectId(String name,
           ObjectId id)
Adds an ObjectId element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.addRegularExpression(String name,
                    Pattern pattern)
Adds a regular expression element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.addRegularExpression(String name,
                    String pattern,
                    String options)
Adds a regular expression element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.addString(String name,
         String value)
Adds a string element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.addSymbol(String name,
         String symbol)
Adds a symbol element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.addTimestamp(String name,
            long timestamp)
Adds a timestamp element. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.addUuid(String name,
       UUID uuid)
Adds a (sub-type 4)  
UUID binary element. | 
protected DocumentBuilder | 
AbstractBuilder.doPush(String name)
Pushes a context for constructing a sub-document. 
 | 
DocumentBuilder | 
ArrayBuilderImpl.push()
Pushes a context for constructing a sub-document. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.push(String name)
Pushes a context for constructing a sub-document. 
 | 
DocumentBuilder | 
DocumentBuilderImpl.remove(String name)
Removes all  
Elements that have the provided name from the
 document being built. | 
DocumentBuilder | 
DocumentBuilderImpl.reset()
Resets the builder back to an empty state. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
static class  | 
AggregationGroupId.Builder
Builder provides the ability to construct a complex
  
AggregationGroupId. | 
| Modifier and Type | Method and Description | 
|---|---|
protected void | 
MongoDatabaseImpl.addOptions(String command,
          DocumentAssignable options,
          DocumentBuilder builder)
Adds the options to the document builder. 
 | 
protected ReadPreference | 
MongoCollectionImpl.updateReadPreference(DocumentBuilder builder,
                    ReadPreference commandReadPreference,
                    boolean createQueryElement)
Determines the  
ReadPreference to be used based on the command's
 ReadPreference or the collection's if the command's
 ReadPreference is null. | 
Copyright © 2011-2013 Allanbank Consulting, Inc.. All Rights Reserved.