com.allanbank.mongodb.bson.builder.impl

Class AbstractBuilder.BuilderElement

java.lang.Object

com.allanbank.mongodb.bson.element.AbstractElement

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

All Implemented Interfaces:

Element, ElementAssignable, Serializable, Comparable<Element>

Enclosing class:

AbstractBuilder

public static final class AbstractBuilder.BuilderElement
extends AbstractElement

A temporary Element to stand in for a element being constructed with a builder.

Note: This class if final to allow the class comparison in AbstractBuilder.subElements() method.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.allanbank.mongodb.bson.element.AbstractElement

ELEMENT_TYPE

Constructor Summary

Constructors

Constructor and Description
AbstractBuilder.BuilderElement(String name, AbstractBuilder builder) Creates a new AbstractBuilder.BuilderElement.

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(Visitor visitor) Accepts the visitor and calls the appropriate method on the visitor based on the element type.
Element	build() Constructs the final form of the element being constructed by the encapsulated builder.
ElementType	getType() Returns the type for the BSON type.
Object	getValueAsObject() Returns the value for BSON element as a Java Object type.
AbstractBuilder.BuilderElement	withName(String name) Creates a new element with the same type and value as this element but with the specified name.

Methods inherited from class com.allanbank.mongodb.bson.element.AbstractElement

asElement, compareTo, equals, find, find, findFirst, findFirst, getName, getValueAsString, hashCode, nullSafeEquals, size, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractBuilder.BuilderElement

public AbstractBuilder.BuilderElement(String name,
                              AbstractBuilder builder)

Creates a new AbstractBuilder.BuilderElement.

Parameters:

name - The name for the element to build.

builder - The Builder doing the building.

Method Detail

accept

public void accept(Visitor visitor)

Accepts the visitor and calls the appropriate method on the visitor based on the element type.

Parameters:

visitor - The visitor for the element.

build

public Element build()

Constructs the final form of the element being constructed by the encapsulated builder.

Returns:

The Element constructed by the encapsulated builder.

getType

public ElementType getType()

Returns the type for the BSON type.

Returns:

The type for the BSON type.

getValueAsObject

public Object getValueAsObject()

Returns the value for BSON element as a Java Object type.

Automatic conversion from the Object-ified value to an element is provided via the DocumentBuilder.add(String, Object) method. Not all element types will be successfully converted to the same element duing a Element-->Object value-->Element conversion. This cases are noted in the appropriate sub-type's JavaDoc.

Sub-types will also overload this method with the appropriate type returned. e.g., The StringElement.getValueAsObject() method signature returns a String.

Overridden to return null as this class should not be seen outside of the builders.

Returns:

The value for BSON element as a Java Object type.

withName

public AbstractBuilder.BuilderElement withName(String name)

Creates a new element with the same type and value as this element but with the specified name. This is useful when creating a query across a set of collections where the filed name changes in the collections but the values must be identical.

Returns a new AbstractBuilder.BuilderElement.

Parameters:

name - The new name for the element.

Returns:

The created element.