org.bson

Class LazyBSONObject

java.lang.Object

org.bson.LazyBSONObject

All Implemented Interfaces:

BSONObject

Direct Known Subclasses:

KeyCachingLazyBSONObject, LazyBSONList, LazyDBObject

public class LazyBSONObject
extends Object
implements BSONObject

An immutable BSONObject backed by a byte buffer that lazily provides keys and values on request. This is useful for transferring BSON documents between servers when you don't want to pay the performance penalty of encoding or decoding them fully.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	LazyBSONObject.LazyBSONKeySet Deprecated. This class is NOT a part of public API and will be dropped in 3.x versions.

Field Summary

Fields

Modifier and Type	Field and Description
protected LazyBSONCallback	_callback Deprecated. This field is NOT a part of public API and will be dropped in 3.x versions.
protected int	_doc_start_offset Deprecated. Please use getOffset() instead.
protected BSONByteBuffer	_input Deprecated. Please use getBytes() to access underlying bytes.

Constructor Summary

Constructors

Constructor and Description
LazyBSONObject(BSONByteBuffer buffer, int offset, LazyBSONCallback callback) Deprecated. use LazyBSONObject(byte[], int, LazyBSONCallback) instead
LazyBSONObject(BSONByteBuffer buffer, LazyBSONCallback callback) Deprecated. use LazyBSONObject(byte[], LazyBSONCallback) instead
LazyBSONObject(byte[] bytes, int offset, LazyBSONCallback callback) Construct an instance.
LazyBSONObject(byte[] bytes, LazyBSONCallback callback) Construct an instance.

Method Summary

Modifier and Type	Method and Description
boolean	containsField(String s) Checks if this object contains a field with the given name.
boolean	containsKey(String s) Deprecated.
Set<Map.Entry<String,Object>>	entrySet() This method will be more efficient than using a combination of keySet() and get(String key)
boolean	equals(Object o)
Object	get(String key) Gets a field from this object by a given name.
int	getBSONSize() Gets the size in bytes of the BSON document.
protected byte[]	getBytes()
protected int	getElementBSONSize(int offset) Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.
protected byte	getElementType(int offset) Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.
protected Object	getElementValue(org.bson.LazyBSONObject.ElementRecord record) Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.
protected int	getOffset()
int	hashCode()
protected boolean	isElementEmpty(int offset) Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.
boolean	isEmpty() Gets whether this is an empty BSONObject.
Set<String>	keySet() Returns this object's fields' names
int	pipe(OutputStream os) Pipe the raw bytes into the given output stream.
Object	put(String key, Object v) Always throws UnsupportedOperationException.
void	putAll(BSONObject o) Always throws UnsupportedOperationException.
void	putAll(Map m) Always throws UnsupportedOperationException.
Object	removeField(String key) Always throws UnsupportedOperationException.
protected int	sizeCString(int offset) Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.
Map	toMap() Returns a map representing this BSONObject.
String	toString() Returns a JSON serialization of this object

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

_doc_start_offset

@Deprecated
protected final int _doc_start_offset

Deprecated. Please use getOffset() instead.

_input

@Deprecated
protected final BSONByteBuffer _input

Deprecated. Please use getBytes() to access underlying bytes.

_callback

@Deprecated
protected final LazyBSONCallback _callback

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

Constructor Detail

LazyBSONObject

public LazyBSONObject(byte[] bytes,
                      LazyBSONCallback callback)

Construct an instance.

Parameters:

bytes - the raw bytes

callback - the callback to use to construct nested values

LazyBSONObject

public LazyBSONObject(byte[] bytes,
                      int offset,
                      LazyBSONCallback callback)

Construct an instance.

Parameters:

bytes - the raw bytes

offset - the offset into the raw bytes representing the start of the document

callback - the callback to use to construct nested values

LazyBSONObject

@Deprecated
public LazyBSONObject(BSONByteBuffer buffer,
                                  LazyBSONCallback callback)

Deprecated. use LazyBSONObject(byte[], LazyBSONCallback) instead

LazyBSONObject

@Deprecated
public LazyBSONObject(BSONByteBuffer buffer,
                                  int offset,
                                  LazyBSONCallback callback)

Deprecated. use LazyBSONObject(byte[], int, LazyBSONCallback) instead

Method Detail

put

public Object put(String key,
                  Object v)

Always throws UnsupportedOperationException.

Specified by:

put in interface BSONObject

Parameters:

key - Name to set

v - Corresponding value

Returns:

will not return normally

Throws:

UnsupportedOperationException

putAll

public void putAll(BSONObject o)

Always throws UnsupportedOperationException.

Specified by:

putAll in interface BSONObject

Parameters:

o - the object

Throws:

UnsupportedOperationException

putAll

public void putAll(Map m)

Always throws UnsupportedOperationException.

Specified by:

putAll in interface BSONObject

Parameters:

m - the map

Throws:

UnsupportedOperationException

get

public Object get(String key)

Description copied from interface: BSONObject

Gets a field from this object by a given name.

Specified by:

get in interface BSONObject

Parameters:

key - The name of the field fetch

Returns:

The field, if found

toMap

public Map toMap()

Description copied from interface: BSONObject

Returns a map representing this BSONObject.

Specified by:

toMap in interface BSONObject

Returns:

the map

removeField

public Object removeField(String key)

Always throws UnsupportedOperationException.

Specified by:

removeField in interface BSONObject

Parameters:

key - The name of the field to remove

Returns:

will not return normally

Throws:

UnsupportedOperationException

containsKey

@Deprecated
public boolean containsKey(String s)

Deprecated.

Description copied from interface: BSONObject

Deprecated

Specified by:

containsKey in interface BSONObject

Parameters:

s - the key to check

Returns:

True if the key is present

containsField

public boolean containsField(String s)

Description copied from interface: BSONObject

Checks if this object contains a field with the given name.

Specified by:

containsField in interface BSONObject

Parameters:

s - Field name for which to check

Returns:

True if the field is present

keySet

public Set<String> keySet()

Description copied from interface: BSONObject

Returns this object's fields' names

Specified by:

keySet in interface BSONObject

Returns:

the set of all keys in the document

entrySet

public Set<Map.Entry<String,Object>> entrySet()

This method will be more efficient than using a combination of keySet() and get(String key)

Returns:

the set of entries (key, value) in the document

isElementEmpty

@Deprecated
protected boolean isElementEmpty(int offset)

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

isEmpty

public boolean isEmpty()

Gets whether this is an empty BSONObject.

Returns:

true if this has no keys

getBSONSize

public int getBSONSize()

Gets the size in bytes of the BSON document.

Returns:

the size in bytes

pipe

public int pipe(OutputStream os)
         throws IOException

Pipe the raw bytes into the given output stream.

Parameters:

os - the output stream

Returns:

the number of bytes written

Throws:

IOException - any IOException thrown by the output stream

getElementType

@Deprecated
protected byte getElementType(int offset)

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

getElementBSONSize

@Deprecated
protected int getElementBSONSize(int offset)

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

sizeCString

@Deprecated
protected int sizeCString(int offset)

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

Returns the size of the BSON cstring at the given offset in the buffer

Parameters:

offset - the offset into the buffer

Returns:

the size of the BSON cstring, including the null terminator

getElementValue

@Deprecated
protected Object getElementValue(org.bson.LazyBSONObject.ElementRecord record)

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

getOffset

protected int getOffset()

getBytes

protected byte[] getBytes()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Returns a JSON serialization of this object

Overrides:

toString in class Object

Returns:

JSON serialization