com.allanbank.mongodb.bson.element

Interface SizeAwareVisitor

All Superinterfaces:

Visitor

public interface SizeAwareVisitor
extends Visitor

Extension for visitors that could benefit from knowledge of the size of the array and document elements.

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	visitArray(String name, List<Element> elements, long totalSize) Visits an array of elements.
void	visitDocument(String name, List<Element> elements, long totalSize) Visits a sub-document element.

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

visit, visitArray, visitBinary, visitBoolean, visitDBPointer, visitDocument, visitDouble, visitInteger, visitJavaScript, visitJavaScript, visitLong, visitMaxKey, visitMinKey, visitMongoTimestamp, visitNull, visitObjectId, visitRegularExpression, visitString, visitSymbol, visitTimestamp

Method Detail

visitArray

void visitArray(String name,
              List<Element> elements,
              long totalSize)

Visits an array of elements.

The ArrayElement implementation ensures that the list of elements is always the same list. Visitors may use this fact to cache intermediate results.

Parameters:

name - The name of the element.

elements - The elements in the array.

totalSize - The total size of the ArrayElement.

visitDocument

void visitDocument(String name,
                 List<Element> elements,
                 long totalSize)

Visits a sub-document element.

The DocumentElement implementation ensures that the list of elements is always the same list. Visitors may use this fact to cache intermediate results.

Parameters:

name - The name of the element.

elements - The sub elements of the document.

totalSize - The total size of the DocumentElement.