org.bson

Class BasicBSONEncoder

java.lang.Object

org.bson.BasicBSONEncoder

All Implemented Interfaces:

BSONEncoder

Direct Known Subclasses:

DefaultDBEncoder

public class BasicBSONEncoder
extends Object
implements BSONEncoder

This is meant to be pooled or cached. There is some per instance memory for string conversion, etc...

Field Summary

Fields

Modifier and Type	Field and Description
protected OutputBuffer	_buf Deprecated. Replaced by getOutputBuffer().

Constructor Summary

Constructors

Constructor and Description
BasicBSONEncoder()

Method Summary

Modifier and Type	Method and Description
protected void	_put(byte type, String name) Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions. Access buffer directly via getOutputBuffer() if you need to change how BSON is written.
protected int	_put(String str) Deprecated. Replaced by getOutputBuffer().writeCString(String).
protected void	_putObjectField(String name, Object val) Encodes any Object type
protected void	_putValueString(String s) Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions. Access buffer directly via getOutputBuffer() if you need to change how BSON is written. Otherwise override putString(String, String).
void	done() Free the resources.
byte[]	encode(BSONObject o) Encode a document into byte array.
protected OutputBuffer	getOutputBuffer() Gets the buffer the BSON is being encoded into.
protected boolean	handleSpecialObjects(String name, BSONObject o) Deprecated. Override putSpecial(String, Object) if you need to you need to handle custom types.
protected void	putBinary(String name, Binary val) Encodes a Binary field
protected void	putBinary(String name, byte[] data) Encodes a byte array field
protected void	putBoolean(String name, Boolean b) Encodes a field with a Boolean or boolean value
protected void	putCode(String name, Code code) Encodes a field to a JAVASCRIPT value.
protected void	putCodeWScope(String name, CodeWScope code) Encodes a field to a JAVASCRIPT_WITH_SCOPE value.
protected void	putDate(String name, Date date) Encodes a field with data and time value.
protected void	putNull(String name) Encodes a null value
protected void	putNumber(String name, Number n) Encodes any number field.
int	putObject(BSONObject o) Encodes a BSONObject.
protected int	putObject(String name, BSONObject o) This is really for embedded objects
protected void	putObjectId(String name, ObjectId oid) Encodes an ObjectId field to an OBJECT_ID.
protected boolean	putSpecial(String name, Object o) Special values are not encoded into documents.
protected void	putString(String name, String value) Encodes a String field
protected void	putSymbol(String name, Symbol symbol) Encodes a Symbol field
protected void	putTimestamp(String name, BSONTimestamp ts) Encodes a BSON timestamp
protected void	putUndefined(String name) Encodes an undefined value
protected void	putUUID(String name, UUID val) Encodes a field with a UUID value.
void	set(OutputBuffer out) Sets the buffer to wrich the result of encoding will be written.
void	writeCString(String s) Deprecated. Replaced by getOutputBuffer().writeCString(String).
void	writeInt(int x) Deprecated. Replaced by getOutputBuffer().writeInt(int).
void	writeLong(long x) Deprecated. Replaced by getOutputBuffer().writeLong(long).

Methods inherited from class java.lang.Object

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

Field Detail

_buf

@Deprecated
protected OutputBuffer _buf

Deprecated. Replaced by getOutputBuffer().

Constructor Detail

BasicBSONEncoder

public BasicBSONEncoder()

Method Detail

encode

public byte[] encode(BSONObject o)

Description copied from interface: BSONEncoder

Encode a document into byte array. This is a shortcut method which creates a new OutputBuffer, invokes the other 3 methods in a corresponding sequence:

• BSONEncoder.set(org.bson.io.OutputBuffer)
• BSONEncoder.putObject(BSONObject)
• BSONEncoder.done()

and returns the contents of the OutputBuffer.

Specified by:

encode in interface BSONEncoder

Parameters:

o - the document to be encoded

Returns:

a byte sequence

set

public void set(OutputBuffer out)

Description copied from interface: BSONEncoder

Sets the buffer to wrich the result of encoding will be written.

Specified by:

set in interface BSONEncoder

Parameters:

out - the buffer to be used to write a byte sequences to

getOutputBuffer

protected OutputBuffer getOutputBuffer()

Gets the buffer the BSON is being encoded into.

Returns:

the OutputBuffer

done

public void done()

Description copied from interface: BSONEncoder

Free the resources.

Specified by:

done in interface BSONEncoder

handleSpecialObjects

@Deprecated
protected boolean handleSpecialObjects(String name,
                                                   BSONObject o)

Deprecated. Override putSpecial(String, Object) if you need to you need to handle custom types.

Returns:

true if object was handled

putSpecial

protected boolean putSpecial(String name,
                             Object o)

Special values are not encoded into documents.

Parameters:

name - the field name

o - the value

Returns:

true if the operation is successful. This implementation always returns false.

putObject

public int putObject(BSONObject o)

Encodes a BSONObject. This is for the higher level api calls.

Specified by:

putObject in interface BSONEncoder

Parameters:

o - the document to encode

Returns:

the number of characters in the encoding

putObject

protected int putObject(String name,
                        BSONObject o)

This is really for embedded objects

Parameters:

name - the field name

o - the object

Returns:

the number of characters in the encoding

_putObjectField

protected void _putObjectField(String name,
                               Object val)

Encodes any Object type

Parameters:

name - the field name

val - the value to write

putNull

protected void putNull(String name)

Encodes a null value

Parameters:

name - the field name

putUndefined

protected void putUndefined(String name)

Encodes an undefined value

Parameters:

name - the field name

putTimestamp

protected void putTimestamp(String name,
                            BSONTimestamp ts)

Encodes a BSON timestamp

Parameters:

name - the field name

ts - the timestamp to encode

putCodeWScope

protected void putCodeWScope(String name,
                             CodeWScope code)

Encodes a field to a JAVASCRIPT_WITH_SCOPE value.

Parameters:

name - the field name

code - the value

putCode

protected void putCode(String name,
                       Code code)

Encodes a field to a JAVASCRIPT value.

Parameters:

name - the field name

code - the value

putBoolean

protected void putBoolean(String name,
                          Boolean b)

Encodes a field with a Boolean or boolean value

Parameters:

name - the field name

b - the value

putDate

protected void putDate(String name,
                       Date date)

Encodes a field with data and time value.

Parameters:

name - the field name

date - the value

putNumber

protected void putNumber(String name,
                         Number n)

Encodes any number field.

Parameters:

name - the field name

n - the number

putBinary

protected void putBinary(String name,
                         byte[] data)

Encodes a byte array field

Parameters:

name - the field name

data - the value

putBinary

protected void putBinary(String name,
                         Binary val)

Encodes a Binary field

Parameters:

name - the field name

val - the value

putUUID

protected void putUUID(String name,
                       UUID val)

Encodes a field with a UUID value. This is encoded to a binary value of subtype UUID_LEGACY

Parameters:

name - the field name

val - the value

putSymbol

protected void putSymbol(String name,
                         Symbol symbol)

Encodes a Symbol field

Parameters:

name - the field name

symbol - the value

putString

protected void putString(String name,
                         String value)

Encodes a String field

Parameters:

name - the field name

value - the value

putObjectId

protected void putObjectId(String name,
                           ObjectId oid)

Encodes an ObjectId field to an OBJECT_ID.

Parameters:

name - the field name

oid - the value

_put

@Deprecated
protected void _put(byte type,
                                String name)

Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions. Access buffer directly via getOutputBuffer() if you need to change how BSON is written.

Encodes the type and key.

_putValueString

@Deprecated
protected void _putValueString(String s)

Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions. Access buffer directly via getOutputBuffer() if you need to change how BSON is written. Otherwise override putString(String, String).

_put

@Deprecated
protected int _put(String str)

Deprecated. Replaced by getOutputBuffer().writeCString(String).

Puts as utf-8 string

writeInt

@Deprecated
public void writeInt(int x)

Deprecated. Replaced by getOutputBuffer().writeInt(int).

Writes integer to underlying buffer.

Parameters:

x - the integer number

writeLong

@Deprecated
public void writeLong(long x)

Deprecated. Replaced by getOutputBuffer().writeLong(long).

Writes long to underlying buffer.

Parameters:

x - the long number

writeCString

@Deprecated
public void writeCString(String s)

Deprecated. Replaced by getOutputBuffer().writeCString(String).

Writes C string (null-terminated string) to underlying buffer.

Parameters:

s - the string