org.bson

Class LazyBSONCallback

java.lang.Object

org.bson.EmptyBSONCallback

org.bson.LazyBSONCallback

All Implemented Interfaces:

BSONCallback

Direct Known Subclasses:

LazyDBCallback

public class LazyBSONCallback
extends EmptyBSONCallback

A BSONCallback for creation of LazyBSONObject and LazyBSONList instances.

Constructor Summary

Constructors

Constructor and Description
LazyBSONCallback()

Method Summary

Methods

Modifier and Type	Method and Description
List	createArray(byte[] bytes, int offset) Create a LazyBSONList from the given bytes starting from the given offset.
Object	createDBRef(String ns, ObjectId id) This is a factory method pattern to create appropriate objects for BSON type DBPointer(0x0c).
Object	createObject(byte[] bytes, int offset) Create a LazyBSONObject instance from the given bytes starting from the given offset.
Object	get() Returns the finished top-level Document.
void	gotBinary(String name, byte type, byte[] data) Called when reading a field with a binary value.
void	reset() Resets the callback, clearing all state.
void	setRootObject(Object root) Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.

Methods inherited from class org.bson.EmptyBSONCallback

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

Methods inherited from class java.lang.Object

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

Constructor Detail

LazyBSONCallback

public LazyBSONCallback()

Method Detail

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 EmptyBSONCallback

get

public Object get()

Description copied from interface: BSONCallback

Returns the finished top-level Document.

Specified by:

get in interface BSONCallback

Overrides:

get in class EmptyBSONCallback

Returns:

the top level document read from the database.

gotBinary

public void gotBinary(String name,
             byte type,
             byte[] data)

Description copied from interface: BSONCallback

Called when reading a field with a binary value. Note that binary values have a subtype, which may determine how the value is processed.

Specified by:

gotBinary in interface BSONCallback

Overrides:

gotBinary in class EmptyBSONCallback

Parameters:

name - the name of the field

type - one of the binary subtypes

data - the field's value

setRootObject

@Deprecated
public void setRootObject(Object root)

Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.

createObject

public Object createObject(byte[] bytes,
                  int offset)

Create a LazyBSONObject instance from the given bytes starting from the given offset.

Parameters:

bytes - the raw BSON bytes

offset - the offset into the bytes

Returns:

the LazyBSONObject

createArray

public List createArray(byte[] bytes,
               int offset)

Create a LazyBSONList from the given bytes starting from the given offset.

Parameters:

bytes - the raw BSON bytes

offset - the offset into the bytes

Returns:

the LazyBSONList

createDBRef

public Object createDBRef(String ns,
                 ObjectId id)

This is a factory method pattern to create appropriate objects for BSON type DBPointer(0x0c).

Parameters:

ns - the namespace of the reference

id - the identifier of the reference

Returns:

object to be used as reference representation