VisitorAdapter (mongodb-async-driver 2.0.1 API)

java.lang.Object
- com.allanbank.mongodb.bson.VisitorAdapter

All Implemented Interfaces:

Visitor

Direct Known Subclasses:

QueryVersionVisitor
```
public class VisitorAdapter
extends Object
implements Visitor
```
VisitorAdapter provides a helper for Visitor implementations that are only interested in a subset of the elements within a document.
This implementation will walk the entire tree of elements. Derived classes need only override the methods of interest. Derived classes should be careful to always call the super implementation of the following methods to ensure they do not break the document walking. Calling super for all methods is encouraged.
As a further aid to Visitor implementations only interested in the names of elements, this class will call the visitName(String) method for each element visited.
API Notice:

This class 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 ©:

2013, Allanbank Consulting, Inc., All Rights Reserved

Constructor Summary

Constructors
Constructor and Description

VisitorAdapter()
Creates a new VisitorAdapter.

Constructors
Constructor and Description
`VisitorAdapter()` Creates a new VisitorAdapter.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`visit(List<Element> elements)` Visit the root document.
`void`	`visitArray(String name, List<Element> elements)` Visits an array of elements.
`void`	`visitBinary(String name, byte subType, byte[] data)` Visits a binary element.
`void`	`visitBoolean(String name, boolean value)` Visits a boolean element.
`void`	`visitDBPointer(String name, String databaseName, String collectionName, ObjectId id)` Visits a deprecated DBPointer element.
`void`	`visitDocument(String name, List<Element> elements)` Visits a sub-document element.
`void`	`visitDouble(String name, double value)` Visits a double element.
`void`	`visitInteger(String name, int value)` Visits a integer (32-bit signed) element.
`void`	`visitJavaScript(String name, String code)` Visits a JavaScript element.
`void`	`visitJavaScript(String name, String code, Document scope)` Visits a JavaScript with Scope element.
`void`	`visitLong(String name, long value)` Visits a long (64-bit signed) element.
`void`	`visitMaxKey(String name)` Visits a minimum key value element.
`void`	`visitMinKey(String name)` Visits a minimum key value element.
`void`	`visitMongoTimestamp(String name, long value)` Visits a MongoDB Timestamp element.
`protected void`	`visitName(String name)` Extension point for `Visitor` implementation only interested in the name of the elements.
`void`	`visitNull(String name)` Visits a `null` valued element.
`void`	`visitObjectId(String name, ObjectId id)` Visits an ObjectId element.
`void`	`visitRegularExpression(String name, String pattern, String options)` Visits a regular expression element.
`void`	`visitString(String name, String value)` Visits a string element.
`void`	`visitSymbol(String name, String symbol)` Visits a symbol element.
`void`	`visitTimestamp(String name, long timestamp)` Visits a timestamp element.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - VisitorAdapter
```
public VisitorAdapter()
```
    Creates a new VisitorAdapter.
- Method Detail
  - visit
```
public void visit(List<Element> elements)
```
    Visit the root document.
    Implementations of Document may see a significant performance enhancement if they ensure that the list of elements is the same list. (Identify check instead of Object.equals(Object).
    
    Overridden to iterate over the elements of the document.
    
    Specified by:
    
    visit in interface Visitor
    
    Parameters:
    elements - The sub elements of the document.
  - visitArray
```
public void visitArray(String name,
              List<Element> elements)
```
    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.
    
    Overridden to visit the name of the element and then iterate over the elements of the array.
    
    Specified by:
    
    visitArray in interface Visitor
    
    Parameters:
    name - The name of the element.
    elements - The elements in the array.
  - visitBinary
```
public void visitBinary(String name,
               byte subType,
               byte[] data)
```
    Visits a binary element.
    Overridden to visit the name of the element.
    
    Specified by:
    
    visitBinary in interface Visitor
    
    Parameters:
    name - The name of the element.
    subType - The binary data sub type.
    data - The binary data.
  - visitBoolean
```
public void visitBoolean(String name,
                boolean value)
```
    Visits a boolean element.
    Overridden to visit the name of the element.
    
    Specified by:
    
    visitBoolean in interface Visitor
    
    Parameters:
    name - The name of the element.
    value - The boolean value.
  - visitDBPointer
```
public void visitDBPointer(String name,
                  String databaseName,
                  String collectionName,
                  ObjectId id)
```
    Visits a deprecated DBPointer element.
    Overridden to visit the name of the element.
    
    Specified by:
    
    visitDBPointer in interface Visitor
    
    Parameters:
    name - The name of the element.
    databaseName - The name of the database containing the document.
    collectionName - The name of the collection containing the document.
    id - The id for the document.
  - visitDocument
```
public void visitDocument(String name,
                 List<Element> elements)
```
    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.
    
    Overridden to visit the name of the element and then iterate over the elements of the document element.
    
    Specified by:
    
    visitDocument in interface Visitor
    
    Parameters:
    name - The name of the element.
    elements - The sub elements of the document.
  - visitDouble
```
public void visitDouble(String name,
               double value)
```
    Visits a double element.
    Overridden to visit the name of the element.
    
    Specified by:
    
    visitDouble in interface Visitor
    
    Parameters:
    name - The name of the element.
    value - The double value.
  - visitInteger
```
public void visitInteger(String name,
                int value)
```
    Visits a integer (32-bit signed) element.
    Overridden to visit the name of the element.
    
    Specified by:
    
    visitInteger in interface Visitor
    
    Parameters:
    name - The name of the element.
    value - The integer value.
  - visitJavaScript
```
public void visitJavaScript(String name,
                   String code)
```
    Visits a JavaScript element.
    Overridden to visit the name of the element.
    
    Specified by:
    
    visitJavaScript in interface Visitor
    
    Parameters:
    name - The name of the element.
    code - The java script code.
  - visitJavaScript
```
public void visitJavaScript(String name,
                   String code,
                   Document scope)
```
    Visits a JavaScript with Scope element.
    Overridden to visit the name of the element.
    
    Specified by:
    
    visitJavaScript in interface Visitor
    
    Parameters:
    name - The name of the element.
    code - The java script code.
    scope - The scope for the JacaScript code.
  - visitLong
```
public void visitLong(String name,
             long value)
```
    Visits a long (64-bit signed) element.
    Overridden to visit the name of the element.
    
    Specified by:
    
    visitLong in interface Visitor
    
    Parameters:
    name - The name of the element.
    value - The long value.
  - visitMaxKey
```
public void visitMaxKey(String name)
```
    Visits a minimum key value element. Used as an absolute upper bounds.
    Overridden to visit the name of the element.
    
    Specified by:
    
    visitMaxKey in interface Visitor
    
    Parameters:
    name - The name of the element.
  - visitMinKey
```
public void visitMinKey(String name)
```
    Visits a minimum key value element. Used as an absolute lower bounds.
    Overridden to visit the name of the element.
    
    Specified by:
    
    visitMinKey in interface Visitor
    
    Parameters:
    name - The name of the element.
  - visitMongoTimestamp
```
public void visitMongoTimestamp(String name,
                       long value)
```
    Visits a MongoDB Timestamp element.
    Overridden to visit the name of the element.
    
    Specified by:
    
    visitMongoTimestamp in interface Visitor
    
    Parameters:
    name - The name of the element.
    value - The mongoDB timstamp value.
  - visitNull
```
public void visitNull(String name)
```
    Visits a null valued element.
    Overridden to visit the name of the element.
    
    Specified by:
    
    visitNull in interface Visitor
    
    Parameters:
    name - The name of the element.
  - visitObjectId
```
public void visitObjectId(String name,
                 ObjectId id)
```
    Visits an ObjectId element.
    Overridden to visit the name of the element.
    
    Specified by:
    
    visitObjectId in interface Visitor
    
    Parameters:
    name - The name of the element.
    id - The object id.
  - visitRegularExpression
```
public void visitRegularExpression(String name,
                          String pattern,
                          String options)
```
    Visits a regular expression element.
    Overridden to visit the name of the element.
    
    Specified by:
    
    visitRegularExpression in interface Visitor
    
    Parameters:
    name - The name of the element.
    pattern - The pattern for the regular expression.
    options - The regular expression options. See the BSON specification for details.
  - visitString
```
public void visitString(String name,
               String value)
```
    Visits a string element.
    Overridden to visit the name of the element.
    
    Specified by:
    
    visitString in interface Visitor
    
    Parameters:
    name - The name of the element.
    value - The string value.
  - visitSymbol
```
public void visitSymbol(String name,
               String symbol)
```
    Visits a symbol element.
    Overridden to visit the name of the element.
    
    Specified by:
    
    visitSymbol in interface Visitor
    
    Parameters:
    name - The name of the element.
    symbol - The symbol value.
  - visitTimestamp
```
public void visitTimestamp(String name,
                  long timestamp)
```
    Visits a timestamp element. The timestamp is the number of milliseconds since the Unix epoch.
    Overridden to visit the name of the element.
    
    Specified by:
    
    visitTimestamp in interface Visitor
    
    Parameters:
    name - The name of the element.
    timestamp - The number of milliseconds since the Unix epoch.
  - visitName
```
protected void visitName(String name)
```
    Extension point for Visitor implementation only interested in the name of the elements.
    
    Parameters:
    name - The name of the element.

Class VisitorAdapter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VisitorAdapter

Method Detail

visit

visitArray

visitBinary

visitBoolean

visitDBPointer

visitDocument

visitDouble

visitInteger

visitJavaScript

visitJavaScript

visitLong

visitMaxKey

visitMinKey

visitMongoTimestamp

visitNull

visitObjectId

visitRegularExpression

visitString

visitSymbol

visitTimestamp

visitName