Module io.inverno.mod.configuration

Package io.inverno.mod.configuration.source

Class SystemEnvironmentConfigurationSource

java.lang.Object

io.inverno.mod.configuration.AbstractConfigurationSource<AbstractPropertiesConfigurationSource.PropertyConfigurationQuery<String,SystemEnvironmentConfigurationSource>,AbstractPropertiesConfigurationSource.PropertyExecutableConfigurationQuery<String,SystemEnvironmentConfigurationSource>,AbstractPropertiesConfigurationSource.PropertyListConfigurationQuery<String,SystemEnvironmentConfigurationSource>,String>

io.inverno.mod.configuration.AbstractPropertiesConfigurationSource<String,SystemEnvironmentConfigurationSource>

io.inverno.mod.configuration.source.SystemEnvironmentConfigurationSource

All Implemented Interfaces:

ConfigurationSource<AbstractPropertiesConfigurationSource.PropertyConfigurationQuery<String,SystemEnvironmentConfigurationSource>,AbstractPropertiesConfigurationSource.PropertyExecutableConfigurationQuery<String,SystemEnvironmentConfigurationSource>,AbstractPropertiesConfigurationSource.PropertyListConfigurationQuery<String,SystemEnvironmentConfigurationSource>>

public class SystemEnvironmentConfigurationSource
extends AbstractPropertiesConfigurationSource<String,SystemEnvironmentConfigurationSource>

A configuration source that looks up properties from the system environment variables.

Note that this source doesn't support parameterized queries, regardless of the parameters specified in a query, only the configuration key name is considered when resolving a value.

Since:

1.0

Author:

Jeremy Kuhn

See Also:

• AbstractPropertiesConfigurationSource

Nested Class Summary

Nested classes/interfaces inherited from class io.inverno.mod.configuration.AbstractPropertiesConfigurationSource

AbstractPropertiesConfigurationSource.PropertyConfigurationQuery<A,B extends AbstractPropertiesConfigurationSource<A,B>>, AbstractPropertiesConfigurationSource.PropertyConfigurationQueryResult<A,B extends AbstractPropertiesConfigurationSource<A,B>>, AbstractPropertiesConfigurationSource.PropertyExecutableConfigurationQuery<A,B extends AbstractPropertiesConfigurationSource<A,B>>, AbstractPropertiesConfigurationSource.PropertyListConfigurationQuery<A,B extends AbstractPropertiesConfigurationSource<A,B>>

Field Summary

Fields inherited from class io.inverno.mod.configuration.AbstractConfigurationSource

decoder

Constructor Summary

Constructors

Constructor	Description
SystemEnvironmentConfigurationSource()	Creates a system environment configuration source.
SystemEnvironmentConfigurationSource(SplittablePrimitiveDecoder<String> decoder)	Creates a system environment configuration source with the specified string value decoder.

Method Summary

Modifier and Type	Method	Description
protected Optional<String>	getPropertyValue(String name)	Returns the value of the property identified by the specified name.
protected Set<String>	listProperties()	Returns the list of property names managed by the source.

Methods inherited from class io.inverno.mod.configuration.AbstractPropertiesConfigurationSource

get, list

Methods inherited from class io.inverno.mod.configuration.AbstractConfigurationSource

getDecoder, setDecoder

Methods inherited from class java.lang.Object

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

Constructor Details

SystemEnvironmentConfigurationSource

public SystemEnvironmentConfigurationSource()

Creates a system environment configuration source.

SystemEnvironmentConfigurationSource

public SystemEnvironmentConfigurationSource(SplittablePrimitiveDecoder<String> decoder)

Creates a system environment configuration source with the specified string value decoder.

Parameters:

decoder - a string decoder

Method Details

getPropertyValue

protected Optional<String> getPropertyValue(String name)

Description copied from class: AbstractPropertiesConfigurationSource

Returns the value of the property identified by the specified name.

This methods should rely on an underlying synchronous property accessor.

Specified by:

getPropertyValue in class AbstractPropertiesConfigurationSource<String,SystemEnvironmentConfigurationSource>

Parameters:

name - the configuration property name

Returns:

an optional returning the configuration property value, or an empty optional if there's no value defined for the specified key

listProperties

protected Set<String> listProperties()

Description copied from class: AbstractPropertiesConfigurationSource

Returns the list of property names managed by the source.

Specified by:

listProperties in class AbstractPropertiesConfigurationSource<String,SystemEnvironmentConfigurationSource>

Returns:

a list of configuration property names