com.mongodb

Class DefaultDBCallback

java.lang.Object

org.bson.BasicBSONCallback

com.mongodb.DefaultDBCallback

All Implemented Interfaces:

DBCallback, BSONCallback

public class DefaultDBCallback
extends BasicBSONCallback
implements DBCallback

This class overrides BasicBSONCallback to implement some extra features specific to the Database. For example DBRef type.

Field Summary

Fields

Modifier and Type	Field and Description
static DBCallbackFactory	FACTORY

Constructor Summary

Constructors

Constructor and Description
DefaultDBCallback(DBCollection coll) Creates a new DefaultDBCallback.

Method Summary

Modifier and Type	Method and Description
BSONObject	create() Factory method for creating a new BSONObject.
BSONObject	create(boolean array, List<String> path) Helper method to create either a BSON Object or a BSON List depending upon whether the array parameter is true or not.
void	gotDBRef(String name, String ns, ObjectId id) Invoked when BSONDecoder encountered a DBPointer(0x0c) type field in a byte sequence.
Object	objectDone() Called at the end of the document/array, and returns this object.
void	objectStart(boolean array, String name) Deprecated. instead, use BasicBSONCallback.arrayStart(String) if array is true, and BasicBSONCallback.objectStart(String) if array is false
void	reset() Resets the callback, clearing all state.

Methods inherited from class org.bson.BasicBSONCallback

_put, arrayDone, arrayStart, arrayStart, createBSONCallback, createList, cur, curName, get, gotBinary, gotBinaryArray, gotBoolean, gotCode, gotCodeWScope, gotDate, gotDouble, gotInt, gotLong, gotMaxKey, gotMinKey, gotNull, gotObjectId, gotRegex, gotString, gotSymbol, gotTimestamp, gotUndefined, gotUUID, isStackEmpty, objectStart, objectStart, objectStart, setRoot

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.bson.BSONCallback

arrayDone, arrayStart, arrayStart, createBSONCallback, get, gotBinary, gotBinaryArray, gotBoolean, gotCode, gotCodeWScope, gotDate, gotDouble, gotInt, gotLong, gotMaxKey, gotMinKey, gotNull, gotObjectId, gotRegex, gotString, gotSymbol, gotTimestamp, gotUndefined, gotUUID, objectStart, objectStart, objectStart

Field Detail

FACTORY

public static DBCallbackFactory FACTORY

Constructor Detail

DefaultDBCallback

public DefaultDBCallback(DBCollection coll)

Creates a new DefaultDBCallback.

Parameters:

coll - an optionally null Collection that the documents created by this callback belong to.

Method Detail

gotDBRef

public void gotDBRef(String name,
                     String ns,
                     ObjectId id)

Description copied from interface: BSONCallback

Invoked when BSONDecoder encountered a DBPointer(0x0c) type field in a byte sequence.

Specified by:

gotDBRef in interface BSONCallback

Overrides:

gotDBRef in class BasicBSONCallback

Parameters:

name - the name of the field

ns - the namespace to which reference is pointing to

id - the if of the object to which reference is pointing to

objectStart

@Deprecated
public void objectStart(boolean array,
                                    String name)

Deprecated. instead, use BasicBSONCallback.arrayStart(String) if array is true, and BasicBSONCallback.objectStart(String) if array is false

Overrides:

objectStart in class BasicBSONCallback

objectDone

public Object objectDone()

Description copied from interface: BSONCallback

Called at the end of the document/array, and returns this object.

Specified by:

objectDone in interface BSONCallback

Overrides:

objectDone in class BasicBSONCallback

Returns:

the Object that has been read from this section of the document.

create

public BSONObject create()

Description copied from class: BasicBSONCallback

Factory method for creating a new BSONObject.

Overrides:

create in class BasicBSONCallback

Returns:

a new BasicBSONObject.

create

public BSONObject create(boolean array,
                         List<String> path)

Description copied from class: BasicBSONCallback

Helper method to create either a BSON Object or a BSON List depending upon whether the array parameter is true or not.

Overrides:

create in class BasicBSONCallback

Parameters:

array - set to true to create a new BSON List, otherwise will create a new BSONObject

path - a list of field names to navigate to this field in the document

Returns:

the new BSONObject

reset

public void reset()

Description copied from interface: BSONCallback

Resets the callback, clearing all state.

Specified by:

reset in interface BSONCallback

Overrides:

reset in class BasicBSONCallback