Package org.bson.codecs

Class MapCodec

java.lang.Object

org.bson.codecs.AbstractMapCodec<Object>

org.bson.codecs.MapCodec

All Implemented Interfaces:

Codec<Map<String,Object>>, Decoder<Map<String,Object>>, Encoder<Map<String,Object>>, OverridableUuidRepresentationCodec<Map<String,Object>>, Parameterizable

public class MapCodec
extends AbstractMapCodec<Object>
implements OverridableUuidRepresentationCodec<Map<String,Object>>, Parameterizable

A Codec for Map instances.

Since:

3.5

Constructor Summary

Constructors

Constructor	Description
MapCodec()	Construct a new instance with a default CodecRegistry
MapCodec(CodecRegistry registry)	Construct a new instance with the given registry
MapCodec(CodecRegistry registry, BsonTypeClassMap bsonTypeClassMap)	Construct a new instance with the given registry and BSON type class map.
MapCodec(CodecRegistry registry, BsonTypeClassMap bsonTypeClassMap, Transformer valueTransformer)	Construct a new instance with the given registry and BSON type class map.

Method Summary

Modifier and Type	Method	Description
Codec<?>	parameterize(CodecRegistry codecRegistry, List<Type> types)	Recursively parameterize the codec with the given registry and generic type arguments.
Codec<Map<String,Object>>	withUuidRepresentation(UuidRepresentation uuidRepresentation)	Implementations must return a new instance with the UuidRepresentation overridden with the given value.

Methods inherited from class org.bson.codecs.AbstractMapCodec

decode, encode, getEncoderClass

Methods inherited from class java.lang.Object

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

Constructor Details

MapCodec

public MapCodec()

Construct a new instance with a default CodecRegistry

MapCodec

public MapCodec(CodecRegistry registry)

Construct a new instance with the given registry

Parameters:

registry - the registry

MapCodec

public MapCodec(CodecRegistry registry,
 BsonTypeClassMap bsonTypeClassMap)

Construct a new instance with the given registry and BSON type class map.

Parameters:

registry - the registry

bsonTypeClassMap - the BSON type class map

MapCodec

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

Construct a new instance with the given registry and BSON type class map. The transformer is applied as a last step when decoding values, which allows users of this codec to control the decoding process. For example, a user of this class could substitute a value decoded as a Document with an instance of a special purpose class (e.g., one representing a DBRef in MongoDB).

Parameters:

registry - the registry

bsonTypeClassMap - the BSON type class map

valueTransformer - the value transformer to use as a final step when decoding the value of any field in the map

Method Details

withUuidRepresentation

public Codec<Map<String,Object>> withUuidRepresentation(UuidRepresentation uuidRepresentation)

Description copied from interface: OverridableUuidRepresentationCodec

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

Specified by:

withUuidRepresentation in interface OverridableUuidRepresentationCodec<Map<String,Object>>

Parameters:

uuidRepresentation - the UuidRepresentation

Returns:

a new instance equivalent to this but with the given UuidRepresentation

parameterize

public Codec<?> parameterize(CodecRegistry codecRegistry,
 List<Type> types)

Description copied from interface: Parameterizable

Recursively parameterize the codec with the given registry and generic type arguments.

Specified by:

parameterize in interface Parameterizable

Parameters:

codecRegistry - the code registry to use to resolve codecs for the generic type arguments

types - the types that are parameterizing the containing type.

Returns:

the Codec parameterized with the given types