com.mongodb

Class DefaultDBEncoder

java.lang.Object

org.bson.BasicBSONEncoder

com.mongodb.DefaultDBEncoder

All Implemented Interfaces:

DBEncoder, BSONEncoder

public class DefaultDBEncoder
extends BasicBSONEncoder
implements DBEncoder

The default BSON encoder for BSONObject instances.

Field Summary

Fields

Modifier and Type	Field and Description
static DBEncoderFactory	FACTORY

Constructor Summary

Constructors

Constructor and Description
DefaultDBEncoder()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	putDBRef(String name, DBRef ref) Deals with encoding database references.
protected boolean	putSpecial(String name, Object value) Special values are not encoded into documents.
String	toString()
int	writeObject(OutputBuffer outputBuffer, BSONObject document) Encode the BSONObject.

Methods inherited from class org.bson.BasicBSONEncoder

_putObjectField, done, encode, getBsonWriter, getOutputBuffer, putArray, putBinary, putBinary, putBoolean, putCode, putCodeWScope, putDate, putIterable, putMap, putMaxKey, putMinKey, putName, putNull, putNumber, putObject, putObject, putObjectId, putPattern, putString, putSymbol, putTimestamp, putUndefined, putUUID, set

Methods inherited from class java.lang.Object

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

Field Detail

FACTORY

public static final DBEncoderFactory FACTORY

Constructor Detail

DefaultDBEncoder

public DefaultDBEncoder()

Method Detail

writeObject

public int writeObject(OutputBuffer outputBuffer,
              BSONObject document)

Description copied from interface: DBEncoder

Encode the BSONObject.

Specified by:

writeObject in interface DBEncoder

Parameters:

outputBuffer - the OutputBuffer to write to

document - the BSONObject to write

Returns:

the number of characters in the encoding

putSpecial

protected boolean putSpecial(String name,
                 Object value)

Description copied from class: BasicBSONEncoder

Special values are not encoded into documents.

Overrides:

putSpecial in class BasicBSONEncoder

Parameters:

name - the field name

value - the value

Returns:

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

putDBRef

protected void putDBRef(String name,
            DBRef ref)

Deals with encoding database references.

Parameters:

name - the name of the field in the document

ref - the database reference object

toString

public String toString()

Overrides:

toString in class Object