Package org.bson.codecs

Class IterableCodec

org.bson.codecs.IterableCodec

All Implemented Interfaces:

>, >, >, >

public class IterableCodec
extends 
implements >, >

Encodes and decodes Iterable objects.

Since:

3.3

Constructor Summary

Constructors

Constructor	Description
IterableCodec(CodecRegistry registry, BsonTypeClassMap bsonTypeClassMap)	Construct a new instance with the given CodecRegistry and BsonTypeClassMap.
IterableCodec(CodecRegistry registry, BsonTypeClassMap bsonTypeClassMap, Transformer valueTransformer)	Construct a new instance with the given CodecRegistry and BsonTypeClassMap.

Method Summary

Modifier and Type	Method	Description
	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, value, EncoderContext encoderContext)	Encode an instance of the type parameter T into a BSON value.
<>	getEncoderClass()	Returns the Class instance that this encodes.
>	withUuidRepresentation(UuidRepresentation uuidRepresentation)	Implementations must return a new instance with the UuidRepresentation overridden with the given value.

Methods inherited from class java.lang.

, , , , , , , , , ,

Constructor Detail

IterableCodec

public IterableCodec(CodecRegistry registry,
                     BsonTypeClassMap bsonTypeClassMap)

Construct a new instance with the given CodecRegistry and BsonTypeClassMap.

Parameters:

registry - the non-null codec registry

bsonTypeClassMap - the non-null BsonTypeClassMap

IterableCodec

public IterableCodec(CodecRegistry registry,
                     BsonTypeClassMap bsonTypeClassMap,
                     Transformer valueTransformer)

Construct a new instance with the given CodecRegistry and BsonTypeClassMap.

Parameters:

registry - the non-null codec registry

bsonTypeClassMap - the non-null BsonTypeClassMap

valueTransformer - the value Transformer

Method Detail

withUuidRepresentation

public > withUuidRepresentation(UuidRepresentation uuidRepresentation)

Description copied from interface: OverridableUuidRepresentationCodec

Implementations must return a new instance with the UuidRepresentation overridden with the given value.

Specified by:

>

Parameters:

uuidRepresentation - the UuidRepresentation

Returns:

a new instance equivalent to this but with the given UuidRepresentation

decode

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

>

Parameters:

reader - the BSON reader

decoderContext - the decoder context

Returns:

an instance of the type parameter T.

encode

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

Description copied from interface: Encoder

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

Specified by:

>

Parameters:

writer - the BSON writer to encode into

value - the value to encode

encoderContext - the encoder context

getEncoderClass

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

>

Returns:

the Class instance that this encodes.