com.cerner.beadledom.configuration

Class EnvironmentConfigurationSource

java.lang.Object

com.cerner.beadledom.configuration.AbstractConfigurationSource

com.cerner.beadledom.configuration.EnvironmentConfigurationSource

All Implemented Interfaces:

ConfigurationSource, Comparable<ConfigurationSource>

public class EnvironmentConfigurationSource
extends AbstractConfigurationSource

An implementation class of ConfigurationSource for the source of environment variables.

Since:

2.7

Author:

Nathan Schile

See Also:

Environment Variables

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PRIORITY

Method Summary

Modifier and Type	Method and Description
static EnvironmentConfigurationSource	create() Creates an instance of EnvironmentConfigurationSource.
static EnvironmentConfigurationSource	create(org.apache.commons.configuration2.EnvironmentConfiguration configuration, int priority) Creates an instance of EnvironmentConfigurationSource.
static EnvironmentConfigurationSource	create(int priority) Creates an instance of EnvironmentConfigurationSource.
org.apache.commons.configuration2.Configuration	getConfig() Returns the Configuration from the ConfigurationSource.
int	getPriority() Returns the priority of the current ConfigurationSources among other ConfigurationSources.

Methods inherited from class com.cerner.beadledom.configuration.AbstractConfigurationSource

compareTo, equals, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PRIORITY

public static final int DEFAULT_PRIORITY

See Also:

Constant Field Values

Method Detail

create

public static EnvironmentConfigurationSource create()

Creates an instance of EnvironmentConfigurationSource.

create

public static EnvironmentConfigurationSource create(int priority)

Creates an instance of EnvironmentConfigurationSource.

Parameters:

priority - priority at which this ConfigurationSource to be loaded among other Configuration sources

create

public static EnvironmentConfigurationSource create(org.apache.commons.configuration2.EnvironmentConfiguration configuration,
                                                    int priority)

Creates an instance of EnvironmentConfigurationSource.

Parameters:

configuration - the system configuration to delegate to

priority - priority at which this ConfigurationSource to be loaded among other Configuration sources

getConfig

public org.apache.commons.configuration2.Configuration getConfig()

Description copied from interface: ConfigurationSource

Returns the Configuration from the ConfigurationSource.

Returns:

a Configuration object.

getPriority

public int getPriority()

Description copied from interface: ConfigurationSource

Returns the priority of the current ConfigurationSources among other ConfigurationSources.

The return value signifies the natural ordering of the instances. Greater Value implies higher priority. Higher Priority ConfigurationSources overrides any matching properties from the lower priority ConfigurationSources.

The priority on a ConfigurationSource must not be negative.

Returns:

an integer indicating the priority of the configuration.