com.allanbank.mongodb.bson.builder.impl

Class AbstractBuilder

java.lang.Object

com.allanbank.mongodb.bson.builder.impl.AbstractBuilder

All Implemented Interfaces:

Builder

Direct Known Subclasses:

ArrayBuilderImpl, DocumentBuilderImpl

public abstract class AbstractBuilder
extends Object
implements Builder

Base class with common functionality for the all builders. A builder is responsible for constructing a single level of the BSON document.

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-2013, Allanbank Consulting, Inc., All Rights Reserved

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractBuilder.BuilderElement A temporary Element to stand in for a element being constructed with a builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	ASSERTIONS_ENABLED If true then assertions have been enabled for the class.
protected static Class<AbstractBuilder.BuilderElement>	BUILDER_ELEMENT_CLASS The class used for intermediate sub-builders in the elements list.
protected List<Element>	myElements The list of elements in the builder.

Constructor Summary

Constructors

Constructor and Description
AbstractBuilder(AbstractBuilder outerBuilder) Creates a new builder.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract Element	build(String name) Constructs the final form of the element being constructed.
protected Element	coerse(String name, Object value) Performs type coersion on the value into the best possible element type.
protected DocumentBuilder	doPush(String name) Pushes a context for constructing a sub-document.
protected ArrayBuilder	doPushArray(String name) Pushes a context for constructing a sub-array.
Builder	pop() Pops the sub-context.
Builder	reset() Resets the builder back to an empty state.
protected List<Element>	subElements() Renders the final form of the sub elements in the builder replacing all AbstractBuilder.BuilderElements with the final element form.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ASSERTIONS_ENABLED

protected static final boolean ASSERTIONS_ENABLED

If true then assertions have been enabled for the class.

BUILDER_ELEMENT_CLASS

protected static final Class<AbstractBuilder.BuilderElement> BUILDER_ELEMENT_CLASS

The class used for intermediate sub-builders in the elements list.

myElements

protected final List<Element> myElements

The list of elements in the builder.

Constructor Detail

AbstractBuilder

public AbstractBuilder(AbstractBuilder outerBuilder)

Creates a new builder.

Parameters:

outerBuilder - The outer scoped builder.

Method Detail

pop

public Builder pop()

Pops the sub-context. Since the outer context might be an array or a document the appropriate builder type cannot be returned and the user must maintain the appropriate outer scoped builder.

Specified by:

pop in interface Builder

Returns:

The outer scoped builder.

reset

public Builder reset()

Resets the builder back to an empty state.

Specified by:

reset in interface Builder

Returns:

This builder for method call chaining.

build

protected abstract Element build(String name)

Constructs the final form of the element being constructed.

Parameters:

name - The name of the element.

Returns:

The Element constructed by the builder.

coerse

protected Element coerse(String name,
             Object value)
                  throws IllegalArgumentException

Performs type coersion on the value into the best possible element type. If the coersion fails then an IllegalArgumentException is thrown.

This method does type inspection which can be slow. It is generally much faster to use the type specific methods of this interface.

Parameters:

name - The name for the element to create.

value - The Object value to coerce into an element.

Returns:

This Element resulting from the coersion.

Throws:

IllegalArgumentException - If the value cannot be coerced into an element type.

doPush

protected DocumentBuilder doPush(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.

doPushArray

protected ArrayBuilder doPushArray(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.

subElements

protected List<Element> subElements()

Renders the final form of the sub elements in the builder replacing all AbstractBuilder.BuilderElements with the final element form.

Returns:

The final sub element list.