org.bson.codecs

Class ObjectIdCodec

java.lang.Object

org.bson.codecs.ObjectIdCodec

All Implemented Interfaces:

Codec<ObjectId>, Decoder<ObjectId>, Encoder<ObjectId>

public class ObjectIdCodec
extends Object
implements Codec<ObjectId>

A Codec for ObjectId instances.

Since:

3.0

Constructor Summary

Constructors

Constructor and Description
ObjectIdCodec()

Method Summary

Modifier and Type	Method and Description
ObjectId	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, ObjectId value, EncoderContext encoderContext) Encode an instance of the type parameter T into a BSON value.
Class<ObjectId>	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

ObjectIdCodec

public ObjectIdCodec()

Method Detail

encode

public void encode(BsonWriter writer,
                   ObjectId 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<ObjectId>

Parameters:

writer - the BSON writer to encode into

value - the value to encode

encoderContext - the encoder context

decode

public ObjectId 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<ObjectId>

Parameters:

reader - the BSON reader

decoderContext - the decoder context

Returns:

an instance of the type parameter T.

getEncoderClass

public Class<ObjectId> 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<ObjectId>

Returns:

the Class instance that this encodes.