com.natpryce.konfig

Interface Configuration

All Known Implementing Classes:

ConfigurationMap, ConfigurationProperties, EnvironmentVariables, LocatedConfiguration, Override, Subset

public Configuration

Looks up configuration properties.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Configuration.DefaultImpls Looks up configuration properties.

Method Summary

Modifier and Type	Method and Description
boolean	contains(Key<?> key)
<T> T	get(Key<? extends T> key) Look up a property value identified by key, or throw class Misconfiguration if there is no definition of the property. Implementations can override missingPropertyMessage to provide a more detailed error message for the exception.
<T> T	getOrElse(Key<? extends T> key, T p) Look up a property value identified by key, or return default with the key if there is no definition of the property.
<T> T	getOrElse(Key<? extends T> key, kotlin.jvm.functions.Function1<? super com.natpryce.konfig.Key<?extendsT>,? extends T> p) Look up a property value identified by key, or call default with the key if there is no definition of the property.
<T> T	getOrNull(Key<? extends T> key) Look up a property value identified by key, or return null if there is no definition of the property.
java.util.List<kotlin.Pair>	list()
java.util.List<com.natpryce.konfig.PropertyLocation>	searchPath(Key<?> key) Report the locations that will be searched for a configuration property, in priority order. The value used is taken from the first location in the list that contains a mapping for the key.

Method Detail

get

<T> T get(Key<? extends T> key)

Look up a property value identified by key, or throw class Misconfiguration if there is no definition of the property. Implementations can override missingPropertyMessage to provide a more detailed error message for the exception.

See Also:

class Misconfiguration

getOrElse

<T> T getOrElse(Key<? extends T> key,
                T p)

Look up a property value identified by key, or return default with the key if there is no definition of the property.

getOrNull

<T> T getOrNull(Key<? extends T> key)

Look up a property value identified by key, or return null if there is no definition of the property.

getOrElse

<T> T getOrElse(Key<? extends T> key,
                kotlin.jvm.functions.Function1<? super com.natpryce.konfig.Key<?extendsT>,? extends T> p)

Look up a property value identified by key, or call default with the key if there is no definition of the property.

contains

boolean contains(Key<?> key)

searchPath

java.util.List<com.natpryce.konfig.PropertyLocation> searchPath(Key<?> key)

Report the locations that will be searched for a configuration property, in priority order. The value used is taken from the first location in the list that contains a mapping for the key.

list

java.util.List<kotlin.Pair> list()