com.allanbank.mongodb.bson.impl

Class ImmutableDocument

java.lang.Object

com.allanbank.mongodb.bson.impl.AbstractDocument

com.allanbank.mongodb.bson.impl.ImmutableDocument

All Implemented Interfaces:

Document, DocumentAssignable, Serializable, Iterable<Element>

public class ImmutableDocument
extends AbstractDocument

A root level document that is truly immutable.

Documents normally returned from the document builders have the ability to be modified by injecting an _id field into the document. This document class does not have that ability.

Most users will not need to use this class except when creating static documents within classes. The intended usage is then to use the builder when constructing the immutable document:

 
 public static final Document QUERY;
 
 ...
 static {
    DocumentBuilder builder = BuilderFactory.start();
 
    builder.add(...);
    ...
 
    QUERY = new ImmutableDocument(builder);
 }
 
 

See Also:

Serialized Form

API Notice:

This interface 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-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
ImmutableDocument(DocumentAssignable document) Constructs a new ImmutableDocument.
ImmutableDocument(DocumentAssignable document, long size) Constructs a new ImmutableDocument.

Method Summary

Methods

Modifier and Type	Method and Description
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.
long	size() Returns the size of the document when encoded as bytes.

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

accept, asDocument, contains, 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

ImmutableDocument

public ImmutableDocument(DocumentAssignable document)

Constructs a new ImmutableDocument.

Parameters:

document - The elements for the BSON document.

ImmutableDocument

public ImmutableDocument(DocumentAssignable document,
                 long size)

Constructs a new ImmutableDocument.

Parameters:

document - The elements for the BSON document.

size - The size of the document when encoded in bytes. If not known then use the ImmutableDocument(DocumentAssignable) constructor instead.

Method Detail

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.

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.