Module org.microbean.loader.microprofile.config.configsource

Package org.microbean.loader.microprofile.config.configsource

Class ConfigSourceProvider.ConverterRegistration<T>

java.lang.Object

org.microbean.loader.microprofile.config.configsource.ConfigSourceProvider.ConverterRegistration<T>

All Implemented Interfaces:

Serializable, Converter<T>

Enclosing class:

ConfigSourceProvider

public static final class ConfigSourceProvider.ConverterRegistration<T>
extends Object
implements Converter<T>

A coupling of a Type, a priority (as defined in the MicroProfile Config specification), and a Converter.

For convenience, this class also implements the Converter interface itself.

Author:

Laird Nelson

See Also:

• ConfigSourceProvider(ConfigSource, Collection)
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ConverterRegistration(Type type, int priority, Converter<? extends T> converter)	Creates a new ConfigSourceProvider.ConverterRegistration.
ConverterRegistration(Type type, Converter<? extends T> converter)	Creates a new ConfigSourceProvider.ConverterRegistration with a priority of 100, following the conventions of the MicroProfile Config specification

Method Summary

Modifier and Type	Method	Description
final T	convert(String configurationValue)	Converts the supplied String-typed configuration value to the conversion type supplied at construction time using the Converter supplied at construction time and returns the result of the conversion.
final int	priority()	Returns the priority of this ConfigSourceProvider.ConverterRegistration.
final Type	type()	Returns the conversion type of this ConfigSourceProvider.ConverterRegistration.

Methods inherited from class java.lang.Object

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

Constructor Details

ConverterRegistration

public ConverterRegistration(Type type,
 Converter<? extends T> converter)

Creates a new ConfigSourceProvider.ConverterRegistration with a priority of 100, following the conventions of the MicroProfile Config specification

Parameters:

type - the conversion type; must not be null

converter - the Converter; must not be null

See Also:

• ConverterRegistration(Type, int, Converter)

ConverterRegistration

public ConverterRegistration(Type type,
 int priority,
 Converter<? extends T> converter)

Creates a new ConfigSourceProvider.ConverterRegistration.

Parameters:

type - the conversion type; must not be null

priority - the priority (as defined in the MicroProfile Config specification)

converter - the Converter; must not be null

Method Details

type

public final Type type()

Returns the conversion type of this ConfigSourceProvider.ConverterRegistration.

Returns:

the conversion type

Idempotency:

This method is idempotent and deterministic.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

priority

public final int priority()

Returns the priority of this ConfigSourceProvider.ConverterRegistration.

Returns:

the priority

Idempotency:

This method is idempotent and deterministic.

Thread Safety:

This method is safe for concurrent use by multiple threads.

convert

public final T convert(String configurationValue)

Converts the supplied String-typed configuration value to the conversion type supplied at construction time using the Converter supplied at construction time and returns the result of the conversion.

Specified by:

convert in interface Converter<T>

Parameters:

configurationValue - the value to convert; must not be null

Returns:

the conversion

Throws:

NullPointerException - if configurationValue is null

IllegalArgumentException - if conversion could not occur for any reason

See Also:

• Converter.convert(String)

Idempotency:

No guarantees are made about idempotency or determinism.

Nullability:

This method may return null.

Thread Safety:

No guarantees are made about thread safety.