Package org.bson.codecs

Class EnumCodec<T extends Enum<T>>

java.lang.Object

org.bson.codecs.EnumCodec<T>

Type Parameters:

T - The enum type

All Implemented Interfaces:

Codec<T>, Decoder<T>, Encoder<T>

public final class EnumCodec<T extends Enum<T>>
extends Object
implements Codec<T>

A codec for classes that extends Enum

Since:

4.5

Constructor Summary

Constructors

Constructor	Description
EnumCodec(Class<T> clazz)	Construct an instance for teh given enum class.

Method Summary

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

EnumCodec

public EnumCodec(Class<T> clazz)

Construct an instance for teh given enum class.

Parameters:

clazz - the enum class

Method Details

decode

public T 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<T extends Enum<T>>

Parameters:

reader - the BSON reader

decoderContext - the decoder context

Returns:

an instance of the type parameter T.

encode

public void encode(BsonWriter writer,
 T 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<T extends Enum<T>>

Parameters:

writer - the BSON writer to encode into

value - the value to encode

encoderContext - the encoder context

getEncoderClass

public Class<T> 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<T extends Enum<T>>

Returns:

the Class instance that this encodes.