com.allanbank.mongodb.builder

Class AggregationGroupId.Builder

java.lang.Object

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

com.allanbank.mongodb.bson.builder.impl.DocumentBuilderImpl

com.allanbank.mongodb.builder.AggregationGroupId.Builder

All Implemented Interfaces:

Builder, DocumentBuilder, DocumentAssignable

Enclosing class:

AggregationGroupId

public static class AggregationGroupId.Builder
extends DocumentBuilderImpl

Builder provides the ability to construct a complex AggregationGroupId.

This AggregationGroupId.Builder also implements the DocumentBuilder interface to allow the construction of arbitrarily complex id documents.

API Notice:

This class 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 ©:

2012-2013, 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, mySize

Constructor Summary

Constructors

Constructor and Description
AggregationGroupId.Builder() Creates a new Builder.

Method Summary

Methods

Modifier and Type	Method and Description
AggregationGroupId.Builder	addField(String fieldRef) Adds a field reference to the id document.
AggregationGroupId.Builder	addField(String name, String fieldRef) Adds a field reference to the id document.
AggregationGroupId	buildId() Constructs a new AggregationGroupId object from the state of the builder.

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

add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, addBinary, addBinary, addBoolean, addDBPointer, addDocument, addDouble, addInteger, addJavaScript, addJavaScript, addLegacyUuid, addLong, addMaxKey, addMinKey, addMongoTimestamp, addNull, addObjectId, addRegularExpression, addRegularExpression, addString, addSymbol, addTimestamp, addUuid, asDocument, build, build, push, pushArray, remove, reset, toString

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, wait, wait, wait

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

pop

Constructor Detail

AggregationGroupId.Builder

public AggregationGroupId.Builder()

Creates a new Builder.

Method Detail

addField

public AggregationGroupId.Builder addField(String fieldRef)

Adds a field reference to the id document. The output field name is the same as the input field.

This method is equivalent to addField(<fieldRef>, <fieldRef>) with appropriate handling for the '$' prefix.

Parameters:

fieldRef - The dotted field path for the field to use. If the fieldRef does not start with a '$' then one will be added.

Returns:

This builder for chaining method calls.

addField

public AggregationGroupId.Builder addField(String name,
                                  String fieldRef)

Adds a field reference to the id document.

Parameters:

name - The name of the field in the id document.

fieldRef - The dotted field path for the field to use. If the fieldRef does not start with a '$' then one will be added.

Returns:

This builder for chaining method calls.

buildId

public AggregationGroupId buildId()

Constructs a new AggregationGroupId object from the state of the builder.

Returns:

The new AggregationGroupId object.