com.natpryce.konfig

Class EnvironmentVariables

com.natpryce.konfig.EnvironmentVariables

All Implemented Interfaces:

Configuration

public class EnvironmentVariables
implements Configuration

Configuration looked up in the environment variables of the process.

Key names are translated from lower-case and periods convention to environment variable names with upper-case and underscore convention, with an optional prefix.

E.g. if the EnvironmentVariables instance is initialised a prefix of "APP", the key name "db.password" will be translated to "APPDBPASSWORD".

Nested Class Summary

Nested classes/interfaces inherited from interface com.natpryce.konfig.Configuration

Configuration.DefaultImpls

Constructor Summary

Constructors

Constructor and Description
EnvironmentVariables(java.lang.String prefix, kotlin.jvm.functions.Function1<? super java.lang.String,java.lang.String> lookup, kotlin.jvm.functions.Function0<? extends java.util.Map<java.lang.String,java.lang.String>> all) Configuration looked up in the environment variables of the process.
EnvironmentVariables() Configuration looked up in the environment variables of the process.

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.
Location	getLocation()
<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.lang.String	getPrefix()
java.util.List<kotlin.Pair>	list()
NonExistentClass	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.

Methods inherited from interface com.natpryce.konfig.Configuration

contains, get, getOrElse, getOrElse, getOrNull, list, searchPath

Constructor Detail

EnvironmentVariables

public EnvironmentVariables(java.lang.String prefix,
                            kotlin.jvm.functions.Function1<? super java.lang.String,java.lang.String> lookup,
                            kotlin.jvm.functions.Function0<? extends java.util.Map<java.lang.String,java.lang.String>> all)

Configuration looked up in the environment variables of the process.

Key names are translated from lower-case and periods convention to environment variable names with upper-case and underscore convention, with an optional prefix.

E.g. if the EnvironmentVariables instance is initialised a prefix of "APP", the key name "db.password" will be translated to "APPDBPASSWORD".

EnvironmentVariables

public EnvironmentVariables()

Configuration looked up in the environment variables of the process.

Key names are translated from lower-case and periods convention to environment variable names with upper-case and underscore convention, with an optional prefix.

E.g. if the EnvironmentVariables instance is initialised a prefix of "APP", the key name "db.password" will be translated to "APPDBPASSWORD".

Method Detail

getLocation

public Location getLocation()

getOrNull

public <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.

searchPath

public NonExistentClass 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

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

getPrefix

public java.lang.String getPrefix()

get

public <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

public <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.

getOrElse

public <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

public boolean contains(Key<?> key)