Package io.helidon.config

Class ConfigMappers

java.lang.Object

io.helidon.config.ConfigMappers

public final class ConfigMappers
extends java.lang.Object

Utility methods for converting configuration to Java types.

Note that this class defines many methods of the form <type> to<type>(String) which are automatically registered with each Config.Builder.

See Also:

ConfigMapper, ConfigMapperProvider

Method Summary

Modifier and Type	Method and Description
static <T> ConfigMapper<T>	from(java.lang.Class<T> type, java.lang.Class<?> builderType) Creates new instance of ConfigMapper that creates new instance of type using specified builder that will be initialized from appropriate Config node.
static java.math.BigDecimal	toBigDecimal(java.lang.String stringValue) Maps stringValue to BigDecimal.
static java.math.BigInteger	toBigInteger(java.lang.String stringValue) Maps stringValue to BigInteger.
static java.lang.Boolean	toBoolean(java.lang.String stringValue) Maps stringValue to boolean.
static java.lang.Byte	toByte(java.lang.String stringValue) Maps stringValue to byte.
static java.util.Calendar	toCalendar(java.lang.String stringValue) Maps stringValue to Calendar.
static java.lang.Character	toChar(java.lang.String stringValue) Maps stringValue to char.
static java.nio.charset.Charset	toCharset(java.lang.String stringValue) Maps stringValue to Charset.
static java.lang.Class<?>	toClass(java.lang.String stringValue) Maps stringValue to Class<?>.
static java.util.Date	toDate(java.lang.String stringValue) Maps stringValue to Date.
static java.lang.Double	toDouble(java.lang.String stringValue) Maps stringValue to double.
static java.time.Duration	toDuration(java.lang.String stringValue) Maps stringValue to Duration.
static java.io.File	toFile(java.lang.String stringValue) Maps stringValue to File.
static java.lang.Float	toFloat(java.lang.String stringValue) Maps stringValue to float.
static java.util.GregorianCalendar	toGregorianCalendar(java.lang.String stringValue) Maps stringValue to GregorianCalendar.
static java.time.Instant	toInstant(java.lang.String stringValue) Maps stringValue to Instant.
static java.lang.Integer	toInt(java.lang.String stringValue) Maps stringValue to int.
static java.time.LocalDate	toLocalDate(java.lang.String stringValue) Maps stringValue to LocalDate.
static java.time.LocalDateTime	toLocalDateTime(java.lang.String stringValue) Maps stringValue to LocalDateTime.
static java.time.LocalTime	toLocalTime(java.lang.String stringValue) Maps stringValue to LocalTime.
static java.lang.Long	toLong(java.lang.String stringValue) Maps stringValue to long.
static java.util.Map<java.lang.String,java.lang.String>	toMap(Config config) Transform all leaf nodes (values) into Map instance.
static java.time.OffsetDateTime	toOffsetDateTime(java.lang.String stringValue) Maps stringValue to OffsetDateTime.
static java.time.OffsetTime	toOffsetTime(java.lang.String stringValue) Maps stringValue to OffsetTime.
static java.nio.file.Path	toPath(java.lang.String stringValue) Maps stringValue to Path.
static java.util.regex.Pattern	toPattern(java.lang.String stringValue) Maps stringValue to Pattern.
static java.time.Period	toPeriod(java.lang.String stringValue) Maps stringValue to Period.
static java.util.Properties	toProperties(Config config) Transform all leaf nodes (values) into Properties instance.
static java.lang.Short	toShort(java.lang.String stringValue) Maps stringValue to short.
static java.util.SimpleTimeZone	toSimpleTimeZone(java.lang.String stringValue) Maps stringValue to SimpleTimeZone.
static java.util.TimeZone	toTimeZone(java.lang.String stringValue) Maps stringValue to TimeZone.
static java.net.URI	toUri(java.lang.String stringValue) Maps stringValue to URI.
static java.net.URL	toUrl(java.lang.String stringValue) Maps stringValue to URL.
static java.util.UUID	toUUID(java.lang.String stringValue) Maps stringValue to UUID.
static java.time.ZonedDateTime	toZonedDateTime(java.lang.String stringValue) Maps stringValue to ZonedDateTime.
static java.time.ZoneId	toZoneId(java.lang.String stringValue) Maps stringValue to ZoneId.
static java.time.ZoneOffset	toZoneOffset(java.lang.String stringValue) Maps stringValue to ZoneOffset.

Methods inherited from class java.lang.Object

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

Method Detail

toByte

public static java.lang.Byte toByte(java.lang.String stringValue)

Maps stringValue to byte.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to byte

toShort

public static java.lang.Short toShort(java.lang.String stringValue)

Maps stringValue to short.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to short

toInt

public static java.lang.Integer toInt(java.lang.String stringValue)

Maps stringValue to int.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to int

toLong

public static java.lang.Long toLong(java.lang.String stringValue)

Maps stringValue to long.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to long

toFloat

public static java.lang.Float toFloat(java.lang.String stringValue)

Maps stringValue to float.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to float

toDouble

public static java.lang.Double toDouble(java.lang.String stringValue)

Maps stringValue to double.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to double

toBoolean

public static java.lang.Boolean toBoolean(java.lang.String stringValue)

Maps stringValue to boolean.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to boolean

toChar

public static java.lang.Character toChar(java.lang.String stringValue)

Maps stringValue to char.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to char

toClass

public static java.lang.Class<?> toClass(java.lang.String stringValue)

Maps stringValue to Class<?>.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to Class<?>

toUUID

public static java.util.UUID toUUID(java.lang.String stringValue)

Maps stringValue to UUID.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to UUID

toBigDecimal

public static java.math.BigDecimal toBigDecimal(java.lang.String stringValue)

Maps stringValue to BigDecimal.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to BigDecimal

toBigInteger

public static java.math.BigInteger toBigInteger(java.lang.String stringValue)

Maps stringValue to BigInteger.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to BigInteger

toFile

public static java.io.File toFile(java.lang.String stringValue)

Maps stringValue to File.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to File

toPath

public static java.nio.file.Path toPath(java.lang.String stringValue)

Maps stringValue to Path.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to Path

toCharset

public static java.nio.charset.Charset toCharset(java.lang.String stringValue)

Maps stringValue to Charset.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to Charset

toPattern

public static java.util.regex.Pattern toPattern(java.lang.String stringValue)

Maps stringValue to Pattern.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to Pattern

toUri

public static java.net.URI toUri(java.lang.String stringValue)

Maps stringValue to URI.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to URI

toUrl

public static java.net.URL toUrl(java.lang.String stringValue)

Maps stringValue to URL.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to URL

toDate

public static java.util.Date toDate(java.lang.String stringValue)

Maps stringValue to Date.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to Date

See Also:

DateTimeFormatter.ISO_DATE_TIME

toCalendar

public static java.util.Calendar toCalendar(java.lang.String stringValue)

Maps stringValue to Calendar.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to Calendar

See Also:

DateTimeFormatter.ISO_DATE_TIME

toGregorianCalendar

public static java.util.GregorianCalendar toGregorianCalendar(java.lang.String stringValue)

Maps stringValue to GregorianCalendar.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to GregorianCalendar

See Also:

DateTimeFormatter.ISO_DATE_TIME

toLocalDate

public static java.time.LocalDate toLocalDate(java.lang.String stringValue)

Maps stringValue to LocalDate.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to LocalDate

See Also:

LocalDate.parse(CharSequence)

toLocalTime

public static java.time.LocalTime toLocalTime(java.lang.String stringValue)

Maps stringValue to LocalTime.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to LocalTime

See Also:

LocalTime.parse(CharSequence)

toLocalDateTime

public static java.time.LocalDateTime toLocalDateTime(java.lang.String stringValue)

Maps stringValue to LocalDateTime.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to LocalDateTime

See Also:

LocalDateTime.parse(CharSequence)

toZonedDateTime

public static java.time.ZonedDateTime toZonedDateTime(java.lang.String stringValue)

Maps stringValue to ZonedDateTime.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to ZonedDateTime

See Also:

ZonedDateTime.parse(CharSequence)

toZoneId

public static java.time.ZoneId toZoneId(java.lang.String stringValue)

Maps stringValue to ZoneId.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to ZoneId

See Also:

ZoneId.of(String)

toZoneOffset

public static java.time.ZoneOffset toZoneOffset(java.lang.String stringValue)

Maps stringValue to ZoneOffset.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to ZoneOffset

See Also:

ZoneOffset.of(String)

toTimeZone

public static java.util.TimeZone toTimeZone(java.lang.String stringValue)

Maps stringValue to TimeZone.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to TimeZone

See Also:

ZoneId.of(String)

toSimpleTimeZone

public static java.util.SimpleTimeZone toSimpleTimeZone(java.lang.String stringValue)

Maps stringValue to SimpleTimeZone.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to SimpleTimeZone

See Also:

ZoneId.of(String)

toInstant

public static java.time.Instant toInstant(java.lang.String stringValue)

Maps stringValue to Instant.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to Instant

See Also:

Instant.parse(CharSequence)

toOffsetDateTime

public static java.time.OffsetDateTime toOffsetDateTime(java.lang.String stringValue)

Maps stringValue to OffsetDateTime.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to OffsetDateTime

See Also:

OffsetDateTime.parse(CharSequence)

toOffsetTime

public static java.time.OffsetTime toOffsetTime(java.lang.String stringValue)

Maps stringValue to OffsetTime.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to OffsetTime

See Also:

OffsetTime.parse(CharSequence)

toDuration

public static java.time.Duration toDuration(java.lang.String stringValue)

Maps stringValue to Duration.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to Duration

See Also:

Duration.parse(CharSequence)

toPeriod

public static java.time.Period toPeriod(java.lang.String stringValue)

Maps stringValue to Period.

Parameters:

stringValue - source value as a String

Returns:

mapped stringValue to Period

See Also:

Period.parse(CharSequence)

toMap

public static java.util.Map<java.lang.String,java.lang.String> toMap(Config config)

Transform all leaf nodes (values) into Map instance.

Fully qualified key of config node is used as a key in returned Map. Detach config node before transforming to Map in case you want to cut current Config node key prefix.

Let's say we work with following configuration:

 app:
      name: Example 1
      page-size: 20
 logging:
      app.level = INFO
      level = WARNING
 

Map app1 contains two keys: app.name, app.page-size.

 Map<String, String> app1 = ConfigMappers.toMap(config.get("app"));
 

Detaching app config node returns new Config instance with "reset" local root.

 Map<String, String> app2 = ConfigMappers.toMap(config.get("app").detach());
 

Map app2 contains two keys without app prefix: name, page-size.

Parameters:

config - config node used to transform into Properties

Returns:

new Map instance that contains all config leaf node values

See Also:

Config.detach()

toProperties

public static java.util.Properties toProperties(Config config)

Transform all leaf nodes (values) into Properties instance.

Fully qualified key of config node is used as a key in returned Properties. Detach config node before transforming to Properties in case you want to cut current Config node key prefix.

Let's say we work with following configuration:

 app:
      name: Example 1
      page-size: 20
 logging:
      app.level = INFO
      level = WARNING
 

Properties app1 contains two keys: app.name, app.page-size.

 Properties app1 = ConfigMappers.toProperties(config.get("app"));
 

Detaching app config node returns new Config instance with "reset" local root.

 Properties app2 = ConfigMappers.toProperties(config.get("app").detach());
 

Properties app2 contains two keys without app prefix: name, page-size.

Parameters:

config - config node used to transform into Properties

Returns:

Properties instance that contains all config leaf node values.

See Also:

Config.detach()

from

public static <T> ConfigMapper<T> from(java.lang.Class<T> type,
                                       java.lang.Class<?> builderType)
                                throws ConfigException

Creates new instance of ConfigMapper that creates new instance of type using specified builder that will be initialized from appropriate Config node.

Advantage of this approach is that there is no connection from type to builderType and builder instance is initialized as an ordinary type from Config.

Type Parameters:

T - supported mapping Java type.

Parameters:

type - supported type of created mapper.

builderType - type of builder used to create type instance.

Returns:

new ConfigMapper instance that creates type instance using builderType instance

Throws:

ConfigException - in case builderType does not follow builder pattern - there is no public build() method that builds type instance.