com.allanbank.mongodb.bson.impl

Class EmptyDocument

java.lang.Object

com.allanbank.mongodb.bson.impl.AbstractDocument

com.allanbank.mongodb.bson.impl.EmptyDocument

All Implemented Interfaces:

Document, DocumentAssignable, Serializable, Iterable<Element>

public class EmptyDocument
extends AbstractDocument

An immutable empty document.

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

Field Summary

Fields

Modifier and Type	Field and Description
static EmptyDocument	INSTANCE An instance of the Empty Document.
static int	SIZE The bytes to encode an empty document.

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

ELEMENT_TYPE, EMPTY_ELEMENTS

Constructor Summary

Constructors

Constructor and Description
EmptyDocument() Constructs a new EmptyDocument.

Method Summary

Methods

Modifier and Type	Method and Description
protected Map<String,Element>	getElementMap() Returns the mapping from the names of elements to the element.
List<Element>	getElements() Returns the array of elements that create this document.
long	size() Returns the size of the empty 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

Field Detail

INSTANCE

public static final EmptyDocument INSTANCE

An instance of the Empty Document.

SIZE

public static final int SIZE

The bytes to encode an empty document. Length (4) + terminal null (1) = 5.

See Also:

Constant Field Values

Constructor Detail

EmptyDocument

public EmptyDocument()

Constructs a new EmptyDocument.

Method Detail

getElements

public List<Element> getElements()

Returns the array of elements that create this document.

Overridden to return an empty list of elements.

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 empty document when encoded as bytes. This is always 5 bytes.

Returns:

The size of the document when encoded as bytes.

getElementMap

protected Map<String,Element> getElementMap()

Returns the mapping from the names of elements to the element.

Overridden to return an empty map as this document is always empty.

Specified by:

getElementMap in class AbstractDocument

Returns:

The mapping from the names of elements to the element.