com.allanbank.mongodb.bson.impl

Class RootDocument

java.lang.Object

com.allanbank.mongodb.bson.impl.AbstractDocument

com.allanbank.mongodb.bson.impl.RootDocument

All Implemented Interfaces:

Document, DocumentAssignable, Serializable, Iterable<Element>

public class RootDocument
extends AbstractDocument

A root level document that can inject a _id value.

See Also:

Serialized Form

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

Field Summary

Fields inherited from class com.allanbank.mongodb.bson.impl.AbstractDocument

ELEMENT_TYPE, EMPTY_ELEMENTS

Constructor Summary

Constructors

Constructor and Description
RootDocument(Element... elements) Constructs a new RootDocument.
RootDocument(List<Element> elements) Constructs a new RootDocument.
RootDocument(List<Element> elements, boolean idPresent) Constructs a new RootDocument.
RootDocument(List<Element> elements, boolean idPresent, long size) Constructs a new RootDocument.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(String name) Returns true if the document contains an element with the specified name.
protected Map<String,Element>	getElementMap() Returns a map from the element names to the elements in the document.
List<Element>	getElements() Returns the elements in the document.
void	injectId() Adds an ObjectIdElement to the head of the document.
long	size() Returns the size of the document when encoded as bytes.

Methods inherited from class com.allanbank.mongodb.bson.impl.AbstractDocument

accept, asDocument, equals, find, find, findFirst, findFirst, get, get, hashCode, iterator, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RootDocument

public RootDocument(Element... elements)

Constructs a new RootDocument.

Parameters:

elements - The elements for the BSON document.

RootDocument

public RootDocument(List<Element> elements)

Constructs a new RootDocument.

Parameters:

elements - The elements for the BSON document.

RootDocument

public RootDocument(List<Element> elements,
            boolean idPresent)

Constructs a new RootDocument.

Parameters:

elements - The elements for the BSON document.

idPresent - If true then there is an _id element in the list of elements.

RootDocument

public RootDocument(List<Element> elements,
            boolean idPresent,
            long size)

Constructs a new RootDocument.

Parameters:

elements - The elements for the BSON document.

idPresent - If true then there is an _id element in the list of elements.

size - The size of the document when encoded in bytes. If not known then use the RootDocument(List, boolean) constructor instead.

Method Detail

contains

public boolean contains(String name)

Returns true if the document contains an element with the specified name.

Specified by:

contains in interface Document

Overrides:

contains in class AbstractDocument

Parameters:

name - The name of the element to locate.

Returns:

True if the document contains an element with the given name, false otherwise.

See Also:

Document.contains(String)

getElements

public List<Element> getElements()

Returns the elements in the document.

Specified by:

getElements in interface Document

Specified by:

getElements in class AbstractDocument

Returns:

The elements in the document.

injectId

public void injectId()

Adds an ObjectIdElement to the head of the document.

size

public long size()

Returns the size of the document when encoded as bytes.

Returns:

The size of the document when encoded as bytes.

getElementMap

protected Map<String,Element> getElementMap()

Returns a map from the element names to the elements in the document. Used for faster by-name access.

Specified by:

getElementMap in class AbstractDocument

Returns:

The element name to element mapping.