org.microbean.configuration.spi

Interface Configuration

All Known Implementing Classes:

AbstractConfiguration, AbstractResourceLoadingConfiguration, ApplicationPropertiesConfiguration, ConfigurationCoordinates, EnvironmentVariablesConfiguration, PropertiesConfiguration, SystemPropertiesConfiguration

public interface Configuration

An accessor of ConfigurationValues in configuration space.

Configuration instances are typically controlled in the service of a governing Configurations object.

Author:

Laird Nelson

See Also:

getValue(Map, String), ConfigurationValue, Configurations.loadConfigurations()

Method Summary

Modifier and Type	Method and Description
Set<String>	getNames() Returns a Set of the names of all ConfigurationValues that might be returned by this Configuration.
ConfigurationValue	getValue(Map<String,String> configurationCoordinates, String name) Returns a ConfigurationValue suitable for the supplied configurationCoordinates and name, or null if there is no suitable value.
void	setConfigurations(Configurations configurations) Installs a Configurations object into this Configuration implementation.

Method Detail

setConfigurations

void setConfigurations(Configurations configurations)

Installs a Configurations object into this Configuration implementation.

Parameters:

configurations - the Configurations to install; must not be null

Throws:

NullPointerException - if configurations is null

getValue

ConfigurationValue getValue(Map<String,String> configurationCoordinates,
                            String name)

Returns a ConfigurationValue suitable for the supplied configurationCoordinates and name, or null if there is no suitable value.

Implementations of this method may return null.

The ConfigurationValue that is returned must have a name that is equal to the supplied name.

The ConfigurationValue that is returned must be created with this Configuration as the first parameter value supplied to its constructor.

The ConfigurationValue that is returned must be created with a set of configuration coordinates that is a subset of the supplied configurationCoordinates.

Parameters:

configurationCoordinates - the configuration coordinates for which a value for the relevant configuration property, identified by the supplied name, should be returned; may be null

name - the name of the configuration property for which a ConfigurationValue will be returned; must not be null

Returns:

a ConfigurationValue suitable for the supplied configurationCoordinates and name, or null

Throws:

NullPointerException - if name is null

See Also:

ConfigurationValue

getNames

Set<String> getNames()

Returns a Set of the names of all ConfigurationValues that might be returned by this Configuration.

Implementations of this method must not return null.

Just because a name appears in the returned Set does not mean that a ConfigurationValue will be returned for it in a location in configuration space identified by any arbitrary set of configuration coordinates.

Returns:

a non-null Set of names