com.natpryce.konfig

Class ConfigurationProperties

LocatedConfiguration

com.natpryce.konfig.ConfigurationProperties

All Implemented Interfaces:

Configuration

public class ConfigurationProperties
extends LocatedConfiguration

Configuration stored in a Properties object.

See Also:

Properties

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigurationProperties.Companion

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

Configuration.DefaultImpls

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigurationProperties.Companion	Companion

Constructor Summary

Constructors

Constructor and Description
ConfigurationProperties(java.util.Properties properties, Location location) Configuration stored in a Properties object.

Method Summary

Modifier and Type	Method and Description
boolean	contains(Key<?> key)
static NonExistentClass	fromFile(java.io.File file) Load from file
static ConfigurationProperties	fromResource(java.lang.Class<?> relativeToClass, java.lang.String resourceName) Load from resources relative to a class
static ConfigurationProperties	fromResource(java.lang.String resourceName) Load from resource within the system classloader.
Location	getLocation()
<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) An implementation that works for a interface Configuration that is loaded from single source, and must be overridden if the interface Configuration searches in multiple sources.
static ConfigurationProperties	systemProperties() Returns the system properties as a Config object.

Methods inherited from class com.natpryce.konfig.LocatedConfiguration

contains, get, getLocation, getOrElse, getOrElse, location, searchPath

Methods inherited from interface com.natpryce.konfig.Configuration

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

Field Detail

Companion

public static ConfigurationProperties.Companion Companion

Constructor Detail

ConfigurationProperties

public ConfigurationProperties(java.util.Properties properties,
                               Location location)

Configuration stored in a Properties object.

See Also:

Properties

Method Detail

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.

contains

public boolean contains(Key<?> key)

searchPath

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

An implementation that works for a interface Configuration that is loaded from single source, and must be overridden if the interface Configuration searches in multiple sources.

See Also:

interface Configuration, interface Configuration

list

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

getLocation

public Location getLocation()

systemProperties

public static ConfigurationProperties systemProperties()

Returns the system properties as a Config object.

fromResource

public static ConfigurationProperties fromResource(java.lang.Class<?> relativeToClass,
                                                   java.lang.String resourceName)

Load from resources relative to a class

fromResource

public static ConfigurationProperties fromResource(java.lang.String resourceName)

Load from resource within the system classloader.

fromFile

public static NonExistentClass fromFile(java.io.File file)

Load from file