org.bson.codecs.configuration

Interface CodecProvider

All Known Implementing Classes:

BsonValueCodecProvider, DBObjectCodecProvider, DBRefCodecProvider, DocumentCodecProvider, GeoJsonCodecProvider, GridFSFileCodecProvider, IterableCodecProvider, UuidCodecProvider, ValueCodecProvider

public interface CodecProvider

A provider of Codec instances. Typically, an instance of a class implementing this interface would be used to construct a CodecRegistry.

While the CodecProvider interface adds no stipulations to the general contract for the Object.equals, programmers who implement the CodecProvider interface "directly" must exercise care if they choose to override the Object.equals. It is not necessary to do so, and the simplest course of action is to rely on Object's implementation, but the implementer may wish to implement a "value comparison" in place of the default "reference comparison."

Since:

3.0

Method Summary

Modifier and Type	Method and Description
<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.

Method Detail

get

<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.

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