org.microbean.configuration.spi

Class PropertiesConfiguration

java.lang.Object

org.microbean.configuration.spi.AbstractConfiguration

org.microbean.configuration.spi.AbstractResourceLoadingConfiguration<Properties>

org.microbean.configuration.spi.PropertiesConfiguration

All Implemented Interfaces:

Serializable, Configuration, Ranked

Direct Known Subclasses:

ApplicationPropertiesConfiguration

public class PropertiesConfiguration
extends AbstractResourceLoadingConfiguration<Properties>
implements Ranked, Serializable

An AbstractResourceLoadingConfiguration that gets configuration property values from Properties resources.

Author:

Laird Nelson

See Also:

AbstractResourceLoadingConfiguration.getValue(Resource, Map, String), Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.microbean.configuration.spi.AbstractResourceLoadingConfiguration

AbstractResourceLoadingConfiguration.Resource<T>

Constructor Summary

Constructors

Constructor and Description
PropertiesConfiguration(Function<? super Map<? extends String,? extends String>,? extends AbstractResourceLoadingConfiguration.Resource<? extends Properties>> resourceLoader) Creates a new PropertiesConfiguration.

Method Summary

Modifier and Type	Method and Description
Set<String>	getNames(AbstractResourceLoadingConfiguration.Resource<? extends Properties> propertiesResource)
protected int	getRank(AbstractResourceLoadingConfiguration.Resource<? extends Properties> resource)
protected ConfigurationValue	getValue(AbstractResourceLoadingConfiguration.Resource<? extends Properties> propertiesResource, Map<String,String> requestedCoordinates, String name) Returns a ConfigurationValue suitable for the supplied name normally sourced in some fashion from the supplied AbstractResourceLoadingConfiguration.Resource, or null if no such ConfigurationValue can be found.

Methods inherited from class org.microbean.configuration.spi.AbstractResourceLoadingConfiguration

getNames, getRank, getValue

Methods inherited from class org.microbean.configuration.spi.AbstractConfiguration

getConfigurations, setConfigurations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.microbean.configuration.spi.Ranked

getRank

Constructor Detail

PropertiesConfiguration

public PropertiesConfiguration(Function<? super Map<? extends String,? extends String>,? extends AbstractResourceLoadingConfiguration.Resource<? extends Properties>> resourceLoader)

Creates a new PropertiesConfiguration.

Parameters:

resourceLoader - a Function that accepts a Map of requested configuration coordinates and returns a Resource that can supply a Properties object to serve as a source of configuration values for use by the AbstractResourceLoadingConfiguration.getValue(Resource, Map, String) method; may be null in which case all invocations of the AbstractResourceLoadingConfiguration.getValue(Map, String) method will return null

See Also:

AbstractResourceLoadingConfiguration.getValue(Resource, Map, String), Resource

Method Detail

getValue

protected ConfigurationValue getValue(AbstractResourceLoadingConfiguration.Resource<? extends Properties> propertiesResource,
                                      Map<String,String> requestedCoordinates,
                                      String name)

Returns a ConfigurationValue suitable for the supplied name normally sourced in some fashion from the supplied AbstractResourceLoadingConfiguration.Resource, or null if no such ConfigurationValue can be found.

Implementations of this method are permitted to return null.

Implementations of this method must not call the AbstractResourceLoadingConfiguration.getValue(Map, String) method or undefined behavior will result.

This implementation gets a Properties object from the supplied Resource and uses it, plus the configuration coordinates supplied by the supplied Resource, to construct and return a suitable ConfigurationValue.

Specified by:

getValue in class AbstractResourceLoadingConfiguration<Properties>

Parameters:

propertiesResource - a Resource that can supply a Properties object to serve as the ultimate source of configuration values for the requested coordinates; must not be null

requestedCoordinates - for convenience, the same Map supplied to the AbstractResourceLoadingConfiguration.getValue(Map, String) method is supplied here representing the configuration coordinates for which a value is requested; note that these may very well be different from the configuration coordinates actually pertaining to the resource; most implementations will not need to reference this parameter

name - the name of the configuration property for which a value is to be sought; must not be null

Returns:

a suitable ConfigurationValue or null

Throws:

NullPointerException - if resource or name is null

See Also:

AbstractResourceLoadingConfiguration.getValue(Map, String), Resource

getNames

public Set<String> getNames(AbstractResourceLoadingConfiguration.Resource<? extends Properties> propertiesResource)

Specified by:

getNames in class AbstractResourceLoadingConfiguration<Properties>

getRank

protected int getRank(AbstractResourceLoadingConfiguration.Resource<? extends Properties> resource)

Overrides:

getRank in class AbstractResourceLoadingConfiguration<Properties>