com.allanbank.mongodb.bson.builder

Class BuilderFactory

java.lang.Object

com.allanbank.mongodb.bson.builder.BuilderFactory

public class BuilderFactory
extends Object

Helper class for getting started with a builder. The use of this class is encouraged to avoid direct references to the builder implementations.

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

2011-2012, Allanbank Consulting, Inc., All Rights Reserved

Method Summary

Methods

Modifier and Type	Method and Description
static DocumentBuilder	start() Creates a new DocumentBuilder.
static DocumentBuilder	start(DocumentAssignable seedDocument) Creates a new DocumentBuilder to append more elements to an existing document.
static ArrayBuilder	startArray() Creates a new ArrayBuilder.

Methods inherited from class java.lang.Object

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

Method Detail

start

public static DocumentBuilder start()

Creates a new DocumentBuilder.

Returns:

The root level document builder.

start

public static DocumentBuilder start(DocumentAssignable seedDocument)

Creates a new DocumentBuilder to append more elements to an existing document.

Parameters:

seedDocument - The document to seed the builder with. The builder will contain the seed document elements plus any added/appended elements.

Returns:

The root level document builder.

startArray

public static ArrayBuilder startArray()

Creates a new ArrayBuilder.

Returns:

The root level array builder.