org.microbean.settings

Interface ConverterProvider

All Known Implementing Classes:

Converters

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ConverterProvider

A provider of appropriately-typed Converter instances, given Class, Type or TypeLiteral instances.

Author:

Laird Nelson

See Also:

getConverter(Class), getConverter(TypeLiteral), getConverter(Type)

Method Summary

Modifier and Type	Method and Description
default <T> Converter<? extends T>	getConverter(Class<T> type) Returns a Converter capable of converting Values into objects of the supplied type.
Converter<?>	getConverter(Type type) Returns a Converter capable of converting Values into objects of the supplied type.
default <T> Converter<? extends T>	getConverter(TypeLiteral<T> type) Returns a Converter capable of converting Values into objects of the supplied type.

Method Detail

getConverter

default <T> Converter<? extends T> getConverter(Class<T> type)

Returns a Converter capable of converting Values into objects of the supplied type.

Type Parameters:

T - the conversion type

Parameters:

type - a Class describing the conversion type; must not be null

Returns:

a non-null Converter capable of converting Values into objects of the proper type

Throws:

NullPointerException - if type is null

IllegalArgumentException - if no Converter is available for the supplied type

See Also:

getConverter(Type)

Idempotency:

Implementations of this method may return different Converter instances over time given the same type.

Nullability:

Implementations of this method must never return null.

Thread Safety:

Implementations of this method must be safe for concurrent use by multiple threads.

getConverter

default <T> Converter<? extends T> getConverter(TypeLiteral<T> type)

Returns a Converter capable of converting Values into objects of the supplied type.

Type Parameters:

T - the conversion type

Parameters:

type - a TypeLiteral describing the conversion type; must not be null

Returns:

a non-null Converter capable of converting Values into objects of the proper type

Throws:

NullPointerException - if type is null

IllegalArgumentException - if no Converter is available for the supplied type

See Also:

getConverter(Type)

Idempotency:

Implementations of this method may return different Converter instances over time given the same type.

Nullability:

Implementations of this method must never return null.

Thread Safety:

Implementations of this method must be safe for concurrent use by multiple threads.

getConverter

Converter<?> getConverter(Type type)

Returns a Converter capable of converting Values into objects of the supplied type.

Implementations of this method must not call either getConverter(Class) or getConverter(TypeLiteral) or undefined behavior may result.

Parameters:

type - a Type describing the conversion type; must not be null

Returns:

a non-null Converter capable of converting Values into objects of the proper type

Throws:

NullPointerException - if type is null

IllegalArgumentException - if no Converter is available for the supplied type

Idempotency:

Implementations of this method may return different Converter instances over time given the same type.

Nullability:

Implementations of this method must never return null.

Thread Safety:

Implementations of this method must be safe for concurrent use by multiple threads.