com.mongodb

Class DBRefCodec

java.lang.Object

com.mongodb.DBRefCodec

All Implemented Interfaces:

Codec<DBRef>, Decoder<DBRef>, Encoder<DBRef>

public class DBRefCodec
extends Object
implements Codec<DBRef>

A Codec for DBRef instances.

Since:

3.0

Constructor Summary

Constructors

Constructor and Description
DBRefCodec(CodecRegistry registry) Construct an instance with the given registry, which is used to encode the id of the referenced document.

Method Summary

Methods

Modifier and Type	Method and Description
DBRef	decode(BsonReader reader, DecoderContext decoderContext) Decodes a BSON value from the given reader into an instance of the type parameter T.
void	encode(BsonWriter writer, DBRef value, EncoderContext encoderContext) Encode an instance of the type parameter T into a BSON value.
Class<DBRef>	getEncoderClass() Returns the Class instance that this encodes.

Methods inherited from class java.lang.Object

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

Constructor Detail

DBRefCodec

public DBRefCodec(CodecRegistry registry)

Construct an instance with the given registry, which is used to encode the id of the referenced document.

Parameters:

registry - the non-null codec registry

Method Detail

encode

public void encode(BsonWriter writer,
          DBRef value,
          EncoderContext encoderContext)

Description copied from interface: Encoder

Encode an instance of the type parameter T into a BSON value.

Specified by:

encode in interface Encoder<DBRef>

Parameters:

writer - the BSON writer to encode into

value - the value to encode

encoderContext - the encoder context

getEncoderClass

public Class<DBRef> getEncoderClass()

Description copied from interface: Encoder

Returns the Class instance that this encodes. This is necessary because Java does not reify generic types.

Specified by:

getEncoderClass in interface Encoder<DBRef>

Returns:

the Class instance that this encodes.

decode

public DBRef decode(BsonReader reader,
           DecoderContext decoderContext)

Description copied from interface: Decoder

Decodes a BSON value from the given reader into an instance of the type parameter T.

Specified by:

decode in interface Decoder<DBRef>

Parameters:

reader - the BSON reader

decoderContext - the decoder context

Returns:

an instance of the type parameter T.