com.allanbank.mongodb.bson

Interface Document

All Superinterfaces:

DocumentAssignable, Iterable<Element>, Serializable

All Known Implementing Classes:

AbstractDocument, DocumentElement, EmptyDocument, ImmutableDocument, RootDocument

public interface Document
extends Iterable<Element>, DocumentAssignable, Serializable

Interface for a document.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(Visitor visitor) Accepts the visitor and calls the appropriate method on the visitor based on the document type.
boolean	contains(String name) Returns true if the document contains an element with the specified name.
<E extends Element> List<E>	find(Class<E> clazz, String... nameRegexs) Returns the elements matching the path of regular expressions.
List<Element>	find(String... nameRegexs) Returns the elements matching the path of regular expressions.
<E extends Element> E	findFirst(Class<E> clazz, String... nameRegexs) Returns the first element matching the path of regular expressions.
Element	findFirst(String... nameRegexs) Returns the first element matching the path of regular expressions.
<E extends Element> E	get(Class<E> clazz, String name) Returns the element with the specified name or null if no element with that name exists.
Element	get(String name) Returns the element with the specified name or null if no element with that name exists.
List<Element>	getElements() Returns the array of elements that create this document.
long	size() Returns the size of the document when encoded as bytes.

Methods inherited from interface java.lang.Iterable

iterator

Methods inherited from interface com.allanbank.mongodb.bson.DocumentAssignable

asDocument

Method Detail

accept

void accept(Visitor visitor)

Accepts the visitor and calls the appropriate method on the visitor based on the document type.

Parameters:

visitor - THe visitor for the document.

contains

boolean contains(String name)

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

Parameters:

name - The name of the element to locate.

Returns:

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

find

<E extends Element> List<E> find(Class<E> clazz,
                               String... nameRegexs)

Returns the elements matching the path of regular expressions.

Type Parameters:

E - The type of element to match.

Parameters:

clazz - The class of elements to match.

nameRegexs - The path of regular expressions.

Returns:

The elements matching the path of regular expressions. May be an empty list but will never be null.

find

List<Element> find(String... nameRegexs)

Returns the elements matching the path of regular expressions.

Parameters:

nameRegexs - The path of regular expressions.

Returns:

The elements matching the path of regular expressions. May be an empty list but will never be null.

findFirst

<E extends Element> E findFirst(Class<E> clazz,
                              String... nameRegexs)

Returns the first element matching the path of regular expressions.

Note: It is much faster to use the get(Class,String) method on a document than to use the findFirst(String...) with a single nameRegexs.

Type Parameters:

E - The type of element to match.

Parameters:

clazz - The class of element to match.

nameRegexs - The path of regular expressions.

Returns:

The first element matching the path of regular expressions.

findFirst

Element findFirst(String... nameRegexs)

Returns the first element matching the path of regular expressions.

Note: It is much faster to use the get(String) method on a document than to use the findFirst(String...) with a single nameRegexs.

Parameters:

nameRegexs - The path of regular expressions.

Returns:

The first element matching the path of regular expressions.

get

<E extends Element> E get(Class<E> clazz,
                        String name)

Returns the element with the specified name or null if no element with that name exists.

Type Parameters:

E - The type of element to get.

Parameters:

clazz - The class of element to get.

name - The name of the element to locate.

Returns:

The sub-element in the document with the given name or null if element exists with the given name.

get

Element get(String name)

Returns the element with the specified name or null if no element with that name exists.

Parameters:

name - The name of the element to locate.

Returns:

The sub-element in the document with the given name or null if element exists with the given name.

getElements

List<Element> getElements()

Returns the array of elements that create this document.

Returns:

The array of elements that create this document.

size

long size()

Returns the size of the document when encoded as bytes.

Returns:

The size of the document when encoded as bytes.