Skip navigation links
C E F G H I K L M N O P S T 

C

CliKt - Class in com.natpryce.konfig
 
com.natpryce.konfig - package com.natpryce.konfig
 
CommandLineOption - Class in com.natpryce.konfig
 
CommandLineOption(configKey, p, p1, description, metavar) - Constructor for class com.natpryce.konfig.CommandLineOption
 
Companion - Static variable in class com.natpryce.konfig.ConfigurationProperties
 
Companion - Static variable in class com.natpryce.konfig.Location
 
component1() - Method in class com.natpryce.konfig.CommandLineOption
 
component1() - Method in class com.natpryce.konfig.Key
 
component1() - Method in class com.natpryce.konfig.Location
 
component1() - Method in class com.natpryce.konfig.PropertyLocation
 
component2() - Method in class com.natpryce.konfig.CommandLineOption
 
component2() - Method in class com.natpryce.konfig.Key
 
component2() - Method in class com.natpryce.konfig.Location
 
component2() - Method in class com.natpryce.konfig.PropertyLocation
 
component3() - Method in class com.natpryce.konfig.CommandLineOption
 
component3() - Method in class com.natpryce.konfig.PropertyLocation
 
component4() - Method in class com.natpryce.konfig.CommandLineOption
 
component5() - Method in class com.natpryce.konfig.CommandLineOption
 
Configuration - Interface in com.natpryce.konfig
Looks up configuration properties.
Configuration.DefaultImpls - Class in com.natpryce.konfig
Looks up configuration properties.
ConfigurationMap - Class in com.natpryce.konfig
Configuration stored in a map.
ConfigurationMap(properties, location) - Constructor for class com.natpryce.konfig.ConfigurationMap
Configuration stored in a map.
ConfigurationMap(entries, location) - Constructor for class com.natpryce.konfig.ConfigurationMap
A convenience method for creating a interface Configuration as an inline expression.
ConfigurationProperties - Class in com.natpryce.konfig
Configuration stored in a Properties object.
ConfigurationProperties(properties, location) - Constructor for class com.natpryce.konfig.ConfigurationProperties
Configuration stored in a Properties object.
ConfigurationProperties.Companion - Class in com.natpryce.konfig
 
contains(key) - Method in interface com.natpryce.konfig.Configuration
 
contains($this, key) - Static method in class com.natpryce.konfig.Configuration.DefaultImpls
 
contains(key) - Method in class com.natpryce.konfig.ConfigurationMap
 
contains(key) - Method in class com.natpryce.konfig.ConfigurationProperties
 
contains(key) - Method in class com.natpryce.konfig.EnvironmentVariables
 
contains(key) - Method in class com.natpryce.konfig.LocatedConfiguration
 
contains(key) - Method in class com.natpryce.konfig.Override
 
contains(key) - Method in class com.natpryce.konfig.Subset
 
copy(configKey, p, p1, description, metavar) - Method in class com.natpryce.konfig.CommandLineOption
 
copy(name, parse) - Method in class com.natpryce.konfig.Key
A key that identifies a named, typed property and can convert a string representation into a value of the type.
copy(description, uri) - Method in class com.natpryce.konfig.Location
Describes the location of configuration information. A location may have a uri or may not, because it is compiled into the application or obtained from ephemeral data, such as the process environment or command-line parameters,
copy(key, source, nameInLocation) - Method in class com.natpryce.konfig.PropertyLocation
Represents the location of a value looked up by a key.

E

enumType(allowed) - Static method in class com.natpryce.konfig.Property_typesKt
An enumerated list of possible values, each specified by the string value used in configuration files and the value used in the program.
enumType(allowed) - Static method in class com.natpryce.konfig.Property_typesKt
 
enumType(allowed) - Static method in class com.natpryce.konfig.Property_typesKt
 
EnvironmentVariables - Class in com.natpryce.konfig
Configuration looked up in the environment variables of the process.
EnvironmentVariables(prefix, lookup, all) - Constructor for class com.natpryce.konfig.EnvironmentVariables
Configuration looked up in the environment variables of the process.
EnvironmentVariables() - Constructor for class com.natpryce.konfig.EnvironmentVariables
Configuration looked up in the environment variables of the process.
equals(p) - Method in class com.natpryce.konfig.CommandLineOption
 
equals(p) - Method in class com.natpryce.konfig.Key
 
equals(p) - Method in class com.natpryce.konfig.Location
 
equals(p) - Method in class com.natpryce.konfig.PropertyLocation
 

F

fromFile(file) - Method in class com.natpryce.konfig.ConfigurationProperties.Companion
Load from file
fromResource(relativeToClass, resourceName) - Method in class com.natpryce.konfig.ConfigurationProperties.Companion
Load from resources relative to a class
fromResource(resourceName) - Method in class com.natpryce.konfig.ConfigurationProperties.Companion
Load from resource within the system classloader.

G

get($this, key) - Static method in class com.natpryce.konfig.Configuration.DefaultImpls
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.
get(key) - Method in interface com.natpryce.konfig.Configuration
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.
get(key) - Method in class com.natpryce.konfig.EnvironmentVariables
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.
get(key) - Method in class com.natpryce.konfig.LocatedConfiguration
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.
get(key) - Method in class com.natpryce.konfig.Override
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.
get(key) - Method in class com.natpryce.konfig.Subset
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.
getBooleanType() - Static method in class com.natpryce.konfig.Property_typesKt
The type of Boolean properties
getConfigKey() - Method in class com.natpryce.konfig.CommandLineOption
 
getDescription() - Method in class com.natpryce.konfig.CommandLineOption
 
getDescription($receiver) - Static method in class com.natpryce.konfig.KonfigKt
 
getDescription() - Method in class com.natpryce.konfig.Location
 
getDescription() - Method in class com.natpryce.konfig.PropertyLocation
 
getDoubleType() - Static method in class com.natpryce.konfig.Property_typesKt
The type of Double properties
getDurationType() - Static method in class com.natpryce.konfig.Time_property_typesKt
 
getFallback() - Method in class com.natpryce.konfig.Override
 
getInstantType() - Static method in class com.natpryce.konfig.Time_property_typesKt
 
getINTRINSIC() - Method in class com.natpryce.konfig.Location.Companion
Describes the location of configuration data that is compiled into the application, as resources or code that creates a interface Configuration object.
getIntType() - Static method in class com.natpryce.konfig.Property_typesKt
The type of Int properties
getKey() - Method in class com.natpryce.konfig.PropertyLocation
 
getLocalDateTimeType() - Static method in class com.natpryce.konfig.Time_property_typesKt
 
getLocalDateType() - Static method in class com.natpryce.konfig.Time_property_typesKt
 
getLocalTimeType() - Static method in class com.natpryce.konfig.Time_property_typesKt
 
getLocation() - Method in class com.natpryce.konfig.ConfigurationMap
 
getLocation() - Method in class com.natpryce.konfig.ConfigurationProperties
 
getLocation() - Method in class com.natpryce.konfig.EnvironmentVariables
 
getLocation() - Method in class com.natpryce.konfig.LocatedConfiguration
 
getLong() - Method in class com.natpryce.konfig.CommandLineOption
 
getLongFlag() - Method in class com.natpryce.konfig.CommandLineOption
 
getLongType() - Static method in class com.natpryce.konfig.Property_typesKt
The type of Long properties
getMetavar() - Method in class com.natpryce.konfig.CommandLineOption
 
getName() - Method in class com.natpryce.konfig.Key
 
getName() - Method in class com.natpryce.konfig.PropertyGroup
 
getNameInLocation() - Method in class com.natpryce.konfig.PropertyLocation
 
getOrElse($this, key, p) - Static method in class com.natpryce.konfig.Configuration.DefaultImpls
Look up a property value identified by key, or return default with the key if there is no definition of the property.
getOrElse($this, key, p) - Static method in class com.natpryce.konfig.Configuration.DefaultImpls
Look up a property value identified by key, or call default with the key if there is no definition of the property.
getOrElse(key, p) - Method in interface com.natpryce.konfig.Configuration
Look up a property value identified by key, or return default with the key if there is no definition of the property.
getOrElse(key, p) - Method in interface com.natpryce.konfig.Configuration
Look up a property value identified by key, or call default with the key if there is no definition of the property.
getOrElse(key, p) - Method in class com.natpryce.konfig.EnvironmentVariables
Look up a property value identified by key, or return default with the key if there is no definition of the property.
getOrElse(key, p) - Method in class com.natpryce.konfig.EnvironmentVariables
Look up a property value identified by key, or call default with the key if there is no definition of the property.
getOrElse(key, p) - Method in class com.natpryce.konfig.LocatedConfiguration
Look up a property value identified by key, or return default with the key if there is no definition of the property.
getOrElse(key, p) - Method in class com.natpryce.konfig.LocatedConfiguration
Look up a property value identified by key, or call default with the key if there is no definition of the property.
getOrElse(key, p) - Method in class com.natpryce.konfig.Override
Look up a property value identified by key, or return default with the key if there is no definition of the property.
getOrElse(key, p) - Method in class com.natpryce.konfig.Override
Look up a property value identified by key, or call default with the key if there is no definition of the property.
getOrElse(key, p) - Method in class com.natpryce.konfig.Subset
Look up a property value identified by key, or return default with the key if there is no definition of the property.
getOrElse(key, p) - Method in class com.natpryce.konfig.Subset
Look up a property value identified by key, or call default with the key if there is no definition of the property.
getOrNull(key) - Method in interface com.natpryce.konfig.Configuration
Look up a property value identified by key, or return null if there is no definition of the property.
getOrNull(key) - Method in class com.natpryce.konfig.ConfigurationMap
Look up a property value identified by key, or return null if there is no definition of the property.
getOrNull(key) - Method in class com.natpryce.konfig.ConfigurationProperties
Look up a property value identified by key, or return null if there is no definition of the property.
getOrNull(key) - Method in class com.natpryce.konfig.EnvironmentVariables
Look up a property value identified by key, or return null if there is no definition of the property.
getOrNull(key) - Method in class com.natpryce.konfig.Override
Look up a property value identified by key, or return null if there is no definition of the property.
getOrNull(key) - Method in class com.natpryce.konfig.Subset
Look up a property value identified by key, or return null if there is no definition of the property.
getOrNullBy(lookup) - Method in class com.natpryce.konfig.Key
 
getOverride() - Method in class com.natpryce.konfig.Override
 
getParse() - Method in class com.natpryce.konfig.Key
 
getPrefix() - Method in class com.natpryce.konfig.EnvironmentVariables
 
getShort() - Method in class com.natpryce.konfig.CommandLineOption
 
getShortFlag() - Method in class com.natpryce.konfig.CommandLineOption
 
getSource() - Method in class com.natpryce.konfig.PropertyLocation
 
getStringType() - Static method in class com.natpryce.konfig.Property_typesKt
A parser for string properties (the identity function)
getUri() - Method in class com.natpryce.konfig.Location
 
getUriType() - Static method in class com.natpryce.konfig.Property_typesKt
The type of URI properties
getValue($receiver, group, property) - Static method in class com.natpryce.konfig.MagicKt
 
getValue($receiver, scope, property) - Static method in class com.natpryce.konfig.MagicKt
 

H

hashCode() - Method in class com.natpryce.konfig.CommandLineOption
 
hashCode() - Method in class com.natpryce.konfig.Key
 
hashCode() - Method in class com.natpryce.konfig.Location
 
hashCode() - Method in class com.natpryce.konfig.PropertyLocation
 

I

INSTANCE - Static variable in class com.natpryce.konfig.ConfigurationProperties.Companion
Deprecated. 
INSTANCE - Static variable in class com.natpryce.konfig.Location.Companion
Deprecated. 
INTRINSIC - Static variable in class com.natpryce.konfig.Location
Deprecated. 

K

Key<T> - Class in com.natpryce.konfig
A key that identifies a named, typed property and can convert a string representation into a value of the type.
Key(name, parse) - Constructor for class com.natpryce.konfig.Key
A key that identifies a named, typed property and can convert a string representation into a value of the type.
key(keySimpleName, type) - Method in class com.natpryce.konfig.PropertyGroup
 
KonfigKt - Class in com.natpryce.konfig
 

L

list() - Method in interface com.natpryce.konfig.Configuration
 
list() - Method in class com.natpryce.konfig.ConfigurationMap
 
list() - Method in class com.natpryce.konfig.ConfigurationProperties
 
list() - Method in class com.natpryce.konfig.EnvironmentVariables
 
list() - Method in class com.natpryce.konfig.Override
 
list() - Method in class com.natpryce.konfig.Subset
 
listType(elementType, separator) - Static method in class com.natpryce.konfig.Property_typesKt
 
LocatedConfiguration - Class in com.natpryce.konfig
 
LocatedConfiguration() - Constructor for class com.natpryce.konfig.LocatedConfiguration
 
location(key) - Method in class com.natpryce.konfig.LocatedConfiguration
 
Location - Class in com.natpryce.konfig
Describes the location of configuration information. A location may have a uri or may not, because it is compiled into the application or obtained from ephemeral data, such as the process environment or command-line parameters,
Location(description, uri) - Constructor for class com.natpryce.konfig.Location
Describes the location of configuration information. A location may have a uri or may not, because it is compiled into the application or obtained from ephemeral data, such as the process environment or command-line parameters,
Location(file) - Constructor for class com.natpryce.konfig.Location
 
Location(uri) - Constructor for class com.natpryce.konfig.Location
 
Location.Companion - Class in com.natpryce.konfig
 

M

MagicKt - Class in com.natpryce.konfig
 
Misconfiguration - Class in com.natpryce.konfig
Error thrown when a mandatory property is missing
Misconfiguration(message, cause) - Constructor for class com.natpryce.konfig.Misconfiguration
Error thrown when a mandatory property is missing
missingPropertyMessage($receiver, key) - Static method in class com.natpryce.konfig.KonfigKt
The message used for the class Misconfiguration exception thrown by get when there is no property defined for key.

N

numericPropertyType(parse) - Static method in class com.natpryce.konfig.Property_typesKt
Wraps a parse function and translates NumberFormatExceptions into class Misconfiguration exceptions.

O

Override - Class in com.natpryce.konfig
Looks up configuration in override and, if the property is not defined there, looks it up in fallback.
Override(override, fallback) - Constructor for class com.natpryce.konfig.Override
Looks up configuration in override and, if the property is not defined there, looks it up in fallback.
overriding($receiver, defaults) - Static method in class com.natpryce.konfig.CliKt
 
overriding($receiver, defaults) - Static method in class com.natpryce.konfig.KonfigKt
 

P

parseArgs(args, options, helpOutput, helpExit, programName, argMetavar) - Static method in class com.natpryce.konfig.CliKt
 
printHelp($receiver, programName, argMetavar, options) - Static method in class com.natpryce.konfig.CliKt
 
Property_typesKt - Class in com.natpryce.konfig
 
PropertyGroup - Class in com.natpryce.konfig
 
PropertyGroup(outer) - Constructor for class com.natpryce.konfig.PropertyGroup
 
PropertyGroup() - Constructor for class com.natpryce.konfig.PropertyGroup
 
PropertyLocation - Class in com.natpryce.konfig
Represents the location of a value looked up by a key.
PropertyLocation(key, source, nameInLocation) - Constructor for class com.natpryce.konfig.PropertyLocation
Represents the location of a value looked up by a key.
propertyType(parse) - Static method in class com.natpryce.konfig.Property_typesKt
Wraps a parse function and translates NumberFormatExceptions into class Misconfiguration exceptions.

S

searchPath(key) - Method in interface com.natpryce.konfig.Configuration
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.
searchPath(key) - Method in class com.natpryce.konfig.ConfigurationProperties
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.
searchPath(key) - Method in class com.natpryce.konfig.EnvironmentVariables
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.
searchPath(key) - Method in class com.natpryce.konfig.LocatedConfiguration
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.
searchPath(key) - Method in class com.natpryce.konfig.Override
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.
searchPath(key) - Method in class com.natpryce.konfig.Subset
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.
Subset - Class in com.natpryce.konfig
Represents a subset of a larger set of configuration properties.
Subset(namePrefix, configuration) - Constructor for class com.natpryce.konfig.Subset
Represents a subset of a larger set of configuration properties.
systemProperties() - Method in class com.natpryce.konfig.ConfigurationProperties.Companion
Returns the system properties as a Config object.

T

Time_property_typesKt - Class in com.natpryce.konfig
 
toString() - Method in class com.natpryce.konfig.CommandLineOption
 
toString() - Method in class com.natpryce.konfig.Key
 
toString() - Method in class com.natpryce.konfig.Location
 
toString() - Method in class com.natpryce.konfig.PropertyLocation
 
C E F G H I K L M N O P S T 
Skip navigation links