Package com.helger.config.source.envvar

Class ConfigurationSourceEnvVar

java.lang.Object

com.helger.config.source.AbstractConfigurationSource

com.helger.config.source.envvar.ConfigurationSourceEnvVar

All Implemented Interfaces:

IConfigurationSource, IIterableConfigurationSource, IConfigurationValueProvider

@Immutable
public class ConfigurationSourceEnvVar
extends AbstractConfigurationSource
implements IIterableConfigurationSource

Default implementation of IConfigurationSource for environment variables.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static final EConfigSourceType	SOURCE_TYPE

Constructor Summary

Constructors

Constructor	Description
ConfigurationSourceEnvVar()
ConfigurationSourceEnvVar(int nPriority)

Method Summary

Modifier and Type	Method	Description
com.helger.collection.commons.ICommonsMap<String,String>	getAllConfigItems()
ConfiguredValue	getConfigurationValue(String sKey)	Get the configuration value with the provided key.
boolean	isInitializedAndUsable()

Methods inherited from class com.helger.config.source.AbstractConfigurationSource

equals, getPriority, getSourceType, hashCode, hasTrailingWhitespace, isSecretKey, mapToStringIgnoreSecrets, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.config.source.IConfigurationSource

getPriority, getSourceType

Methods inherited from interface com.helger.config.source.IIterableConfigurationSource

getAllConfiguredValues

Field Details

SOURCE_TYPE

public static final EConfigSourceType SOURCE_TYPE

Constructor Details

ConfigurationSourceEnvVar

public ConfigurationSourceEnvVar()

ConfigurationSourceEnvVar

public ConfigurationSourceEnvVar(int nPriority)

Method Details

isInitializedAndUsable

public boolean isInitializedAndUsable()

Specified by:

isInitializedAndUsable in interface IConfigurationSource

Returns:

true if the file was successfully initialized and can be used as a configuration source.

getConfigurationValue

@Nullable
public ConfiguredValue getConfigurationValue(@Nonnull @Nonempty
 String sKey)

Description copied from interface: IConfigurationValueProvider

Get the configuration value with the provided key.

Specified by:

getConfigurationValue in interface IConfigurationValueProvider

Parameters:

sKey - The key to be retrieved. May neither be null nor empty.

Returns:

null if no such value is available.

getAllConfigItems

@Nonnull
@ReturnsMutableCopy
public com.helger.collection.commons.ICommonsMap<String,String> getAllConfigItems()

Specified by:

getAllConfigItems in interface IIterableConfigurationSource

Returns:

A map of all contained keys with their values in this configuration source. If the underlying source uses some kind of ordering (e.g. in files), this order should be maintained. Never null but maybe empty.