Package com.mongodb

Class DBObjectCodec

java.lang.Object

com.mongodb.DBObjectCodec

All Implemented Interfaces:

Codec<DBObject>, CollectibleCodec<DBObject>, Decoder<DBObject>, Encoder<DBObject>, OverridableUuidRepresentationCodec<DBObject>

public class DBObjectCodec
extends Object
implements CollectibleCodec<DBObject>, OverridableUuidRepresentationCodec<DBObject>

A collectible codec for a DBObject.

Since:

3.0

Constructor Summary

Constructors

Constructor	Description
DBObjectCodec()	Construct an instance with the default codec registry
DBObjectCodec(CodecRegistry codecRegistry)	Construct an instance with the given codec registry.
DBObjectCodec(CodecRegistry codecRegistry, BsonTypeClassMap bsonTypeClassMap)	Construct an instance.
DBObjectCodec(CodecRegistry codecRegistry, BsonTypeClassMap bsonTypeClassMap, com.mongodb.DBObjectFactory objectFactory)	Construct an instance.

Method Summary

Modifier and Type	Method	Description
DBObject	decode(BsonReader reader, DecoderContext decoderContext)
boolean	documentHasId(DBObject document)
void	encode(BsonWriter writer, DBObject document, EncoderContext encoderContext)
DBObject	generateIdIfAbsentFromDocument(DBObject document)
BsonValue	getDocumentId(DBObject document)
Class<DBObject>	getEncoderClass()
Codec<DBObject>	withUuidRepresentation(UuidRepresentation uuidRepresentation)

Methods inherited from class java.lang.Object

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

Constructor Detail

DBObjectCodec

public DBObjectCodec()

Construct an instance with the default codec registry

Since:

3.7

DBObjectCodec

public DBObjectCodec(CodecRegistry codecRegistry)

Construct an instance with the given codec registry.

Parameters:

codecRegistry - the non-null codec registry

DBObjectCodec

public DBObjectCodec(CodecRegistry codecRegistry,
                     BsonTypeClassMap bsonTypeClassMap)

Construct an instance.

Parameters:

codecRegistry - the codec registry

bsonTypeClassMap - the non-null BsonTypeClassMap

DBObjectCodec

public DBObjectCodec(CodecRegistry codecRegistry,
                     BsonTypeClassMap bsonTypeClassMap,
                     com.mongodb.DBObjectFactory objectFactory)

Construct an instance.

Parameters:

codecRegistry - the non-null codec registry

bsonTypeClassMap - the non-null BsonTypeClassMap

objectFactory - the non-null object factory used to create empty DBObject instances when decoding

Method Detail

encode

public void encode(BsonWriter writer,
                   DBObject document,
                   EncoderContext encoderContext)

Specified by:

encode in interface Encoder<DBObject>

decode

public DBObject decode(BsonReader reader,
                       DecoderContext decoderContext)

Specified by:

decode in interface Decoder<DBObject>

getEncoderClass

public Class<DBObject> getEncoderClass()

Specified by:

getEncoderClass in interface Encoder<DBObject>

documentHasId

public boolean documentHasId(DBObject document)

Specified by:

documentHasId in interface CollectibleCodec<DBObject>

getDocumentId

public BsonValue getDocumentId(DBObject document)

Specified by:

getDocumentId in interface CollectibleCodec<DBObject>

generateIdIfAbsentFromDocument

public DBObject generateIdIfAbsentFromDocument(DBObject document)

Specified by:

generateIdIfAbsentFromDocument in interface CollectibleCodec<DBObject>

withUuidRepresentation

public Codec<DBObject> withUuidRepresentation(UuidRepresentation uuidRepresentation)

Specified by:

withUuidRepresentation in interface OverridableUuidRepresentationCodec<DBObject>