com.cerner.beadledom.configuration

Interface ConfigurationSource

All Superinterfaces:

Comparable<ConfigurationSource>

All Known Implementing Classes:

AbstractConfigurationSource, EnvironmentConfigurationSource, JndiConfigurationSource, PropertiesConfigurationSource, XmlConfigurationSource

public interface ConfigurationSource
extends Comparable<ConfigurationSource>

Definition of the source based on a specific format of the Configuration .

It is strictly recommended that no Concrete class should implement this interface directly. Instead they should be extend from AbstractConfigurationSource to ensure that all the ConfigurationSources are compared using the same method AbstractConfigurationSource.compareTo(ConfigurationSource).

Every implementation of ConfigurationSource must have a priority (an Integer value) set on them. Configurations are loaded based on the priority set on them. The properties from the lower priority configurations are overriden by the higher priority configurations.

Note: The implementations of this interface have a natural ordering that is inconsistent with the Object.equals(java.lang.Object) method. Two Configuration classes might have an equal priority but might not be equal. Hence the natural ordering on the implementations of this interface MUST NOT be used to determine the equality of the objects. The Natural ordering of the instances can be obtained from the getPriority() method.

Since:

1.7

Author:

Sundeep Paruvu

See Also:

Comparable, AbstractConfigurationSource

Method Summary

Modifier and Type	Method and Description
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 interface java.lang.Comparable

compareTo

Method Detail

getConfig

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

Returns the Configuration from the ConfigurationSource.

Returns:

a Configuration object.

getPriority

int getPriority()

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.