com.allanbank.mongodb.bson.builder

Interface ArrayBuilder

All Superinterfaces:

Builder

All Known Implementing Classes:

ArrayBuilderImpl

public interface ArrayBuilder
extends Builder

Interface for a builder used to construct a BSON array.

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

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

pop

Method Detail

add

ArrayBuilder add(boolean value)

Adds a boolean element.

This is a equivalent to addBoolean(boolean) but less verbose.

Parameters:

value - The boolean value.

Returns:

This ArrayBuilder for method chaining.

add

ArrayBuilder add(byte subType,
               byte[] data)

Adds a binary element.

This is a equivalent to addBinary(byte, byte[]) but less verbose.

Parameters:

subType - The sub-type for the binary data.

data - The binary value.

Returns:

This ArrayBuilder for method chaining.

add

ArrayBuilder add(byte[] data)

Adds a binary element using sub-type zero (the default).

This is a equivalent to addBinary(byte[]) but less verbose.

Parameters:

data - The binary value.

Returns:

This ArrayBuilder for method chaining.

add

ArrayBuilder add(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:

timestamp - The number of milliseconds since the Unix epoch.

Returns:

This ArrayBuilder for method chaining.

add

ArrayBuilder add(DocumentAssignable document)

Adds a pre-constructed document to the array.

This is a equivalent to addDocument(DocumentAssignable) but less verbose.

Parameters:

document - The document to add to the array.

Returns:

This ArrayBuilder for method chaining.

add

ArrayBuilder add(double value)

Adds a double element.

This is a equivalent to addDouble(double) but less verbose.

Parameters:

value - The double value.

Returns:

This ArrayBuilder for method chaining.

add

ArrayBuilder add(ElementAssignable element)

Adds a pre-built element to the document.

Parameters:

element - The element to add.

Returns:

This ArrayBuilder for method chaining.

add

ArrayBuilder add(int value)

Adds a integer (32-bit signed) element.

This is a equivalent to addInteger(int) but less verbose.

Parameters:

value - The integer value.

Returns:

This ArrayBuilder for method chaining.

add

ArrayBuilder add(long value)

Adds a long (64-bit signed) element.

This is a equivalent to addLong(long) but less verbose.

Parameters:

value - The long value.

Returns:

This ArrayBuilder for method chaining.

add

ArrayBuilder add(ObjectId id)

Adds an ObjectId element.

This is a equivalent to addObjectId(ObjectId) but less verbose.

Parameters:

id - The ObjectId to add.

Returns:

This ArrayBuilder for method chaining.

add

ArrayBuilder add(Pattern pattern)

Adds an ObjectId element.

This is a equivalent to addRegularExpression(Pattern) but less verbose.

Parameters:

pattern - The pattern for the regular expression.

Returns:

This ArrayBuilder for method chaining.

add

ArrayBuilder add(String value)

Adds a string element.

This is a equivalent to addString(String) but less verbose.

Parameters:

value - The string value.

Returns:

This ArrayBuilder for method chaining.

add

@Deprecated
ArrayBuilder add(String databaseName,
                          String collectionName,
                          ObjectId id)

Deprecated. See BSON specification.

Adds a deprecated DBPointer element.

This is a equivalent to addDBPointer(String, String, ObjectId) but less verbose.

Parameters:

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 ArrayBuilder for method chaining.

addBinary

ArrayBuilder addBinary(byte subType,
                     byte[] data)

Adds a binary element.

Parameters:

subType - The sub-type for the binary data.

data - The binary value.

Returns:

This ArrayBuilder for method chaining.

addBinary

ArrayBuilder addBinary(byte[] data)

Adds a binary element using sub-type zero (the default).

Parameters:

data - The binary value.

Returns:

This ArrayBuilder for method chaining.

addBoolean

ArrayBuilder addBoolean(boolean value)

Adds a boolean element.

Parameters:

value - The boolean value.

Returns:

This ArrayBuilder for method chaining.

addDBPointer

@Deprecated
ArrayBuilder addDBPointer(String databaseName,
                                   String collectionName,
                                   ObjectId id)

Deprecated. See BSON specification.

Adds a deprecated DBPointer element.

Parameters:

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 ArrayBuilder for method chaining.

addDocument

ArrayBuilder addDocument(DocumentAssignable document)

Adds a pre-constructed document to the array.

Parameters:

document - The document to add to the array.

Returns:

This ArrayBuilder for method chaining.

addDouble

ArrayBuilder addDouble(double value)

Adds a double element.

Parameters:

value - The double value.

Returns:

This ArrayBuilder for method chaining.

addInteger

ArrayBuilder addInteger(int value)

Adds a integer (32-bit signed) element.

Parameters:

value - The integer value.

Returns:

This ArrayBuilder for method chaining.

addJavaScript

ArrayBuilder addJavaScript(String code)

Adds a JavaScript element.

Parameters:

code - The java script code.

Returns:

This ArrayBuilder for method chaining.

addJavaScript

ArrayBuilder addJavaScript(String code,
                         DocumentAssignable scope)

Adds a JavaScript with Scope element.

Parameters:

code - The java script code.

scope - The scope for the JacaScript code.

Returns:

This ArrayBuilder for method chaining.

addLong

ArrayBuilder addLong(long value)

Adds a long (64-bit signed) element.

Parameters:

value - The long value.

Returns:

This ArrayBuilder for method chaining.

addMaxKey

ArrayBuilder addMaxKey()

Adds a minimum key value element. Used as an absolute upper bounds.

Returns:

This ArrayBuilder for method chaining.

addMinKey

ArrayBuilder addMinKey()

Adds a minimum key value element. Used as an absolute lower bounds.

Returns:

This ArrayBuilder for method chaining.

addMongoTimestamp

ArrayBuilder addMongoTimestamp(long value)

Adds a MongoDB Timestamp element.

Parameters:

value - The mongoDB timstamp value.

Returns:

This ArrayBuilder for method chaining.

addNull

ArrayBuilder addNull()

Adds a null valued element.

Returns:

This ArrayBuilder for method chaining.

addObjectId

ArrayBuilder addObjectId(ObjectId id)

Adds an ObjectId element.

Parameters:

id - The ObjectId to add.

Returns:

This ArrayBuilder for method chaining.

addRegularExpression

ArrayBuilder addRegularExpression(Pattern pattern)

Adds a regular expression element.

Parameters:

pattern - The pattern for the regular expression.

Returns:

This ArrayBuilder for method chaining.

addRegularExpression

ArrayBuilder addRegularExpression(String pattern,
                                String options)

Adds a regular expression element.

Parameters:

pattern - The pattern for the regular expression.

options - The regular expression options. See the BSON specification for details.

Returns:

This ArrayBuilder for method chaining.

addString

ArrayBuilder addString(String value)

Adds a string element.

Parameters:

value - The string value.

Returns:

This ArrayBuilder for method chaining.

addSymbol

ArrayBuilder addSymbol(String symbol)

Adds a symbol element.

Parameters:

symbol - The symbol value.

Returns:

This ArrayBuilder for method chaining.

addTimestamp

ArrayBuilder addTimestamp(long timestamp)

Adds a timestamp element. The timestamp is the number of milliseconds since the Unix epoch.

Parameters:

timestamp - The number of milliseconds since the Unix epoch.

Returns:

This ArrayBuilder for method chaining.

build

Element[] build()

Returns the array of Elements being constructed.

Returns:

The constructed array of Element.

push

DocumentBuilder push()

Pushes a context for constructing a sub-document.

Returns:

This ArrayBuilder for method chaining.

pushArray

ArrayBuilder pushArray()

Pushes a context for constructing a sub-array.

Returns:

This ArrayBuilder for method chaining.

reset

ArrayBuilder reset()

Resets the builder back to an empty state.

Overridden to return an ArrayBuilder instance.

Specified by:

reset in interface Builder

Returns:

This builder for method call chaining.