org.bson.codecs.configuration

Class CodecRegistryHelper

java.lang.Object

org.bson.codecs.configuration.CodecRegistryHelper

public final class CodecRegistryHelper
extends Object

A helper class for creating and combining codec registries

Since:

3.0

Method Summary

Methods

Modifier and Type	Method and Description
static <T> CodecRegistry	fromCodec(Codec<T> codec) Creates a codec registry from the provided codec
static CodecRegistry	fromProvider(CodecProvider codecProvider) A codec registry that uses a single codec provider when looking for codecs.
static CodecRegistry	fromProviders(List<CodecProvider> codecProviders) A codec registry that contains a list of providers to use when looking for codecs.
static CodecRegistry	fromRegistries(CodecRegistry firstRegistry, CodecRegistry secondRegistry) A codec registry that compounds two registries.

Methods inherited from class java.lang.Object

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

Method Detail

fromCodec

public static <T> CodecRegistry fromCodec(Codec<T> codec)

Creates a codec registry from the provided codec

This registry can then be used alongside other registries. Typically used when adding extra codecs to existing codecs with the fromRegistries(CodecRegistry, CodecRegistry) helper.

Type Parameters:

T - the value type of the codec

Parameters:

codec - the codec to create a registry for

Returns:

a codec registry for the given codec.

fromProvider

public static CodecRegistry fromProvider(CodecProvider codecProvider)

A codec registry that uses a single codec provider when looking for codecs.

Parameters:

codecProvider - the codec provider

Returns:

a codec registry that uses a codec provider to find codecs

fromProviders

public static CodecRegistry fromProviders(List<CodecProvider> codecProviders)

A codec registry that contains a list of providers to use when looking for codecs. This class can handle cycles of Codec dependencies, i.e when the construction of a Codec for class A requires the construction of a Codec for class B, and vice versa.

Parameters:

codecProviders - the list of codec providers

Returns:

a codec registry that has an ordered list of codec providers.

fromRegistries

public static CodecRegistry fromRegistries(CodecRegistry firstRegistry,
                           CodecRegistry secondRegistry)

A codec registry that compounds two registries.

The first registry is checked first then if that returns null the second registry is checked.

Parameters:

firstRegistry - the preferred registry for codec lookups

secondRegistry - the fallback registry for codec lookups.

Returns:

a codec registry that has a preferred registry when looking for codecs.