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

Methods

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)
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()
byte[]	encode(BSONObject o)
protected OutputBuffer	getOutputBuffer() Gets the buffer this encoder is writing to.
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)
protected void	putBinary(String name, byte[] data)
protected void	putBoolean(String name, Boolean b)
protected void	putCode(String name, Code code)
protected void	putCodeWScope(String name, CodeWScope code)
protected void	putDate(String name, Date d)
protected void	putNull(String name)
protected void	putNumber(String name, Number n)
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)
protected boolean	putSpecial(String name, Object o)
protected void	putString(String name, String s)
protected void	putSymbol(String name, Symbol s)
protected void	putTimestamp(String name, BSONTimestamp ts)
protected void	putUndefined(String name)
protected void	putUUID(String name, UUID val)
void	set(OutputBuffer out)
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)

Specified by:

encode in interface BSONEncoder

set

public void set(OutputBuffer out)

Specified by:

set in interface BSONEncoder

getOutputBuffer

protected OutputBuffer getOutputBuffer()

Gets the buffer this encoder is writing to.

Returns:

the output buffer

done

public void done()

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)

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 object to encode

Returns:

the number of characters in the encoding

putObject

protected int putObject(String name,
            BSONObject o)

this is really for embedded objects

_putObjectField

protected void _putObjectField(String name,
                   Object val)

putNull

protected void putNull(String name)

putUndefined

protected void putUndefined(String name)

putTimestamp

protected void putTimestamp(String name,
                BSONTimestamp ts)

putCodeWScope

protected void putCodeWScope(String name,
                 CodeWScope code)

putCode

protected void putCode(String name,
           Code code)

putBoolean

protected void putBoolean(String name,
              Boolean b)

putDate

protected void putDate(String name,
           Date d)

putNumber

protected void putNumber(String name,
             Number n)

putBinary

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

putBinary

protected void putBinary(String name,
             Binary val)

putUUID

protected void putUUID(String name,
           UUID val)

putSymbol

protected void putSymbol(String name,
             Symbol s)

putString

protected void putString(String name,
             String s)

putObjectId

protected void putObjectId(String name,
               ObjectId oid)

_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