Package org.bson.codecs

Class DocumentCodecProvider

java.lang.Object

org.bson.codecs.DocumentCodecProvider

All Implemented Interfaces:

CodecProvider

public class DocumentCodecProvider
extends Object
implements CodecProvider

A CodecProvider for the Document class and all the default Codec implementations on which it depends.

Since:

3.0

Constructor Summary

Constructors

Constructor	Description
DocumentCodecProvider()	Construct a new instance with a default BsonTypeClassMap.
DocumentCodecProvider(BsonTypeClassMap bsonTypeClassMap)	Construct a new instance with the given instance of BsonTypeClassMap.
DocumentCodecProvider(BsonTypeClassMap bsonTypeClassMap, Transformer valueTransformer)	Construct a new instance with the given instance of BsonTypeClassMap.
DocumentCodecProvider(Transformer valueTransformer)	Construct a new instance with a default BsonTypeClassMap and the given Transformer.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
<T> Codec<T>	get(Class<T> clazz, CodecRegistry registry)	Get a Codec using the given context, which includes, most importantly, the Class for which a Codec is required.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.bson.codecs.configuration.CodecProvider

get

Constructor Details

DocumentCodecProvider

public DocumentCodecProvider()

Construct a new instance with a default BsonTypeClassMap.

DocumentCodecProvider

public DocumentCodecProvider(Transformer valueTransformer)

Construct a new instance with a default BsonTypeClassMap and the given Transformer. The transformer is used by the DocumentCodec as a last step when decoding values.

Parameters:

valueTransformer - the value transformer for decoded values

See Also:

• DocumentCodec(org.bson.codecs.configuration.CodecRegistry, BsonTypeClassMap, org.bson.Transformer)

DocumentCodecProvider

public DocumentCodecProvider(BsonTypeClassMap bsonTypeClassMap)

Construct a new instance with the given instance of BsonTypeClassMap.

Parameters:

bsonTypeClassMap - the non-null BsonTypeClassMap with which to construct instances of DocumentCodec and ListCodec

DocumentCodecProvider

public DocumentCodecProvider(BsonTypeClassMap bsonTypeClassMap,
 Transformer valueTransformer)

Construct a new instance with the given instance of BsonTypeClassMap.

Parameters:

bsonTypeClassMap - the non-null BsonTypeClassMap with which to construct instances of DocumentCodec and ListCodec.

valueTransformer - the value transformer for decoded values

Method Details

get

public <T> Codec<T> get(Class<T> clazz,
 CodecRegistry registry)

Description copied from interface: CodecProvider

Get a Codec using the given context, which includes, most importantly, the Class for which a Codec is required.

This method is called by the driver only if CodecProvider.get(Class, List, CodecRegistry) is not overridden, or is overridden such that it calls this method.

Specified by:

get in interface CodecProvider

Type Parameters:

T - the type of the class for which a Codec is required

Parameters:

clazz - the Class for which to get a Codec

registry - the registry to use for resolving dependent Codec instances

Returns:

the Codec instance, which may be null, if this source is unable to provide one for the requested Class

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object