io.smallrye.config

Class Converters

java.lang.Object

io.smallrye.config.Converters

public final class Converters
extends Object

General converter utilities and constants.

Author:

Jeff Mesnil (c) 2017 Red Hat inc.

Method Summary

Modifier and Type	Method and Description
static Type	getConverterType(Class<?> clazz) Get the type of the converter specified by clazz.
static <T> org.eclipse.microprofile.config.spi.Converter<T>	getImplicitConverter(Class<T> type) Get the implicit converter for the given type class, if any.
static <T extends Comparable<T>> org.eclipse.microprofile.config.spi.Converter<T>	maximumValueConverter(org.eclipse.microprofile.config.spi.Converter<T> delegate, T maximumValue, boolean inclusive) Get a wrapping converter which verifies that the configuration value is less than, or optionally equal to, the given maximum value.
static <T extends Comparable<T>> org.eclipse.microprofile.config.spi.Converter<T>	minimumValueConverter(org.eclipse.microprofile.config.spi.Converter<T> delegate, T minimumValue, boolean inclusive) Get a wrapping converter which verifies that the configuration value is greater than, or optionally equal to, the given minimum value.
static <A,T> org.eclipse.microprofile.config.spi.Converter<A>	newArrayConverter(org.eclipse.microprofile.config.spi.Converter<T> itemConverter, Class<A> arrayType) Get a converter that converts a comma-separated string into an array of converted items.
static <T,C extends Collection<T>> org.eclipse.microprofile.config.spi.Converter<C>	newCollectionConverter(org.eclipse.microprofile.config.spi.Converter<T> itemConverter, IntFunction<C> collectionFactory) Get a converter that converts a comma-separated string into a list of converted items.
static <T> org.eclipse.microprofile.config.spi.Converter<T>	patternValidatingConverter(org.eclipse.microprofile.config.spi.Converter<T> delegate, Pattern pattern) Get a wrapping converter which verifies that the configuration value matches the given pattern.
static <T> org.eclipse.microprofile.config.spi.Converter<T>	patternValidatingConverter(org.eclipse.microprofile.config.spi.Converter<T> delegate, String pattern) Get a wrapping converter which verifies that the configuration value matches the given pattern.
static <T extends Comparable<T>> org.eclipse.microprofile.config.spi.Converter<T>	rangeValueConverter(org.eclipse.microprofile.config.spi.Converter<T> delegate, T minimumValue, boolean minInclusive, T maximumValue, boolean maxInclusive) Get a wrapping converter which verifies that the configuration value is within the given range.

Methods inherited from class java.lang.Object

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

Method Detail

getConverterType

public static Type getConverterType(Class<?> clazz)

Get the type of the converter specified by clazz. If the given class is not a valid converter, then null is returned.

Parameters:

clazz - the converter class (must not be null)

Returns:

the converter target type, or null if the class does not represent a valid configuration

Throws:

IllegalStateException - if the given converter class is not properly parameterized

getImplicitConverter

public static <T> org.eclipse.microprofile.config.spi.Converter<T> getImplicitConverter(Class<T> type)

Get the implicit converter for the given type class, if any.

Type Parameters:

T - the type

Parameters:

type - the type class

Returns:

the implicit converter for the given type class, or null if none exists

newCollectionConverter

public static <T,C extends Collection<T>> org.eclipse.microprofile.config.spi.Converter<C> newCollectionConverter(org.eclipse.microprofile.config.spi.Converter<T> itemConverter,
                                                                                                                  IntFunction<C> collectionFactory)

Get a converter that converts a comma-separated string into a list of converted items.

Type Parameters:

T - the item type

C - the collection type

Parameters:

itemConverter - the item converter (must not be null)

collectionFactory - the collection factory (must not be null)

Returns:

the new converter (not null)

newArrayConverter

public static <A,T> org.eclipse.microprofile.config.spi.Converter<A> newArrayConverter(org.eclipse.microprofile.config.spi.Converter<T> itemConverter,
                                                                                       Class<A> arrayType)

Get a converter that converts a comma-separated string into an array of converted items.

Type Parameters:

T - the item type

A - the array type

Parameters:

itemConverter - the item converter (must not be null)

arrayType - the array type class (must not be null)

Returns:

the new converter (not null)

minimumValueConverter

public static <T extends Comparable<T>> org.eclipse.microprofile.config.spi.Converter<T> minimumValueConverter(org.eclipse.microprofile.config.spi.Converter<T> delegate,
                                                                                                               T minimumValue,
                                                                                                               boolean inclusive)

Get a wrapping converter which verifies that the configuration value is greater than, or optionally equal to, the given minimum value.

Type Parameters:

T - the converter target type

Parameters:

delegate - the delegate converter (must not be null)

minimumValue - the minimum value (must not be null)

inclusive - true if the minimum value is inclusive, false otherwise

Returns:

a range-validating converter

maximumValueConverter

public static <T extends Comparable<T>> org.eclipse.microprofile.config.spi.Converter<T> maximumValueConverter(org.eclipse.microprofile.config.spi.Converter<T> delegate,
                                                                                                               T maximumValue,
                                                                                                               boolean inclusive)

Get a wrapping converter which verifies that the configuration value is less than, or optionally equal to, the given maximum value.

Type Parameters:

T - the converter target type

Parameters:

delegate - the delegate converter (must not be null)

maximumValue - the maximum value (must not be null)

inclusive - true if the maximum value is inclusive, false otherwise

Returns:

a range-validating converter

rangeValueConverter

public static <T extends Comparable<T>> org.eclipse.microprofile.config.spi.Converter<T> rangeValueConverter(org.eclipse.microprofile.config.spi.Converter<T> delegate,
                                                                                                             T minimumValue,
                                                                                                             boolean minInclusive,
                                                                                                             T maximumValue,
                                                                                                             boolean maxInclusive)

Get a wrapping converter which verifies that the configuration value is within the given range.

Type Parameters:

T - the converter target type

Parameters:

delegate - the delegate converter (must not be null)

maximumValue - the maximum value (must not be null)

maxInclusive - true if the maximum value is inclusive, false otherwise

Returns:

a range-validating converter

patternValidatingConverter

public static <T> org.eclipse.microprofile.config.spi.Converter<T> patternValidatingConverter(org.eclipse.microprofile.config.spi.Converter<T> delegate,
                                                                                              Pattern pattern)

Get a wrapping converter which verifies that the configuration value matches the given pattern.

Type Parameters:

T - the converter target type

Parameters:

delegate - the delegate converter (must not be null)

pattern - the pattern to match (must not be null)

Returns:

a pattern-validating converter

patternValidatingConverter

public static <T> org.eclipse.microprofile.config.spi.Converter<T> patternValidatingConverter(org.eclipse.microprofile.config.spi.Converter<T> delegate,
                                                                                              String pattern)

Get a wrapping converter which verifies that the configuration value matches the given pattern.

Type Parameters:

T - the converter target type

Parameters:

delegate - the delegate converter (must not be null)

pattern - the pattern string to match (must not be null)

Returns:

a pattern-validating converter

Throws:

PatternSyntaxException - if the given pattern has invalid syntax