Class ValueConverterRegistry

java.lang.Object

com.soklet.converter.ValueConverterRegistry

@ThreadSafe
public final class ValueConverterRegistry
extends Object

A collection of ValueConverter instances, supplemented with quality-of-life features that most applications need.

For example, the registry will automatically generate and cache off ValueConverter instances when a requested 'from' type is String and the 'to' type is an Enum if no converter was previously specified (this is almost always the behavior you want).

The registry will also perform primitive mapping when locating ValueConverter instances. For example, if a requested 'from' String and 'to' int are specified and that converter does not exist, but a 'from' String and 'to' Integer does exist, it will be returned.

Finally, reflexive ValueConverter instances are automatically created and cached off when the requested 'from' and 'to' types are identical.

Value conversion is documented in detail at https://www.soklet.com/docs/value-conversions.

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
static @NonNull ValueConverterRegistry	fromBlankSlate()	Acquires a registry without any default converters or automatic enum/reflexive conversions.
static @NonNull ValueConverterRegistry	fromBlankSlateSupplementedBy(@NonNull Set<@NonNull ValueConverter<?,?>> customValueConverters)	Acquires a registry without any default converters or automatic enum/reflexive conversions, supplemented with custom converters.
static @NonNull ValueConverterRegistry	fromDefaults()	Acquires a registry with a sensible default set of converters as specified by ValueConverters.defaultValueConverters().
static @NonNull ValueConverterRegistry	fromDefaultsSupplementedBy(@NonNull Set<@NonNull ValueConverter<?,?>> customValueConverters)	Acquires a registry with a sensible default set of converters as specified by ValueConverters.defaultValueConverters(), supplemented with custom converters.
<F,T> @NonNull Optional<ValueConverter<F,T>>	get(@NonNull TypeReference<F> fromTypeReference, @NonNull TypeReference<T> toTypeReference)	Obtains a ValueConverter that matches the 'from' and 'to' type references specified.
@NonNull Optional<ValueConverter<Object,Object>>	get(@NonNull Type fromType, @NonNull Type toType)	Obtain a ValueConverter that matches the 'from' and 'to' types specified.

Methods inherited from class Object

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

Method Details

fromDefaults

public static @NonNull ValueConverterRegistry fromDefaults()

Acquires a registry with a sensible default set of converters as specified by ValueConverters.defaultValueConverters().

This method is guaranteed to return a new instance.

Returns:

a registry instance with sensible defaults

fromDefaultsSupplementedBy

public static @NonNull ValueConverterRegistry fromDefaultsSupplementedBy(@NonNull Set<@NonNull ValueConverter<?,?>> customValueConverters)

Acquires a registry with a sensible default set of converters as specified by ValueConverters.defaultValueConverters(), supplemented with custom converters.

This method is guaranteed to return a new instance.

Parameters:

customValueConverters - the custom value converters to include in the registry

Returns:

a registry instance with sensible defaults, supplemented with custom converters

fromBlankSlate

public static @NonNull ValueConverterRegistry fromBlankSlate()

Acquires a registry without any default converters or automatic enum/reflexive conversions.

This method is guaranteed to return a new instance.

Returns:

a registry instance without defaults or automatic conversions

fromBlankSlateSupplementedBy

public static @NonNull ValueConverterRegistry fromBlankSlateSupplementedBy(@NonNull Set<@NonNull ValueConverter<?,?>> customValueConverters)

Acquires a registry without any default converters or automatic enum/reflexive conversions, supplemented with custom converters.

This method is guaranteed to return a new instance.

Parameters:

customValueConverters - the custom value converters to include in the registry

Returns:

a registry instance without defaults or automatic conversions, supplemented with custom converters

get

public <F,T> @NonNull Optional<ValueConverter<F,T>> get(@NonNull TypeReference<F> fromTypeReference,
 @NonNull TypeReference<T> toTypeReference)

Obtains a ValueConverter that matches the 'from' and 'to' type references specified.

Because of type erasure, you cannot directly express a generic type like List<String>.class. You must encode it as a type parameter - in this case, new TypeReference<List<String>>() {}.

Type Parameters:

F - the 'from' type

T - the 'to' type

Parameters:

fromTypeReference - reference to the 'from' type of the converter

toTypeReference - reference to the 'to' type of the converter

Returns:

a matching ValueConverter, or Optional.empty() if not found

get

public @NonNull Optional<ValueConverter<Object,Object>> get(@NonNull Type fromType,
 @NonNull Type toType)

Obtain a ValueConverter that matches the 'from' and 'to' types specified.

Parameters:

fromType - the 'from' type

toType - the 'to' type

Returns:

a matching ValueConverter, or Optional.empty() if not found