org.yarnandtail.andhow.internal

Class AndHowCore

java.lang.Object

org.yarnandtail.andhow.internal.AndHowCore

All Implemented Interfaces:

ConstructionDefinition, ValueMap

public class AndHowCore
extends Object
implements ConstructionDefinition, ValueMap

Actual central instance of the AndHow state after a successful startup. The advertised AndHow class is really a proxy for this class, and allows interaction with the AndHow framework prior to startup, reloading during unit testing, and (potentially) a future implementation where reloading of production data would be allowed.

Author:

eeverman

Field Summary

Fields inherited from interface org.yarnandtail.andhow.api.ConstructionDefinition

EMPTY_PROPERTY_LIST

Constructor Summary

Constructors

Constructor and Description
AndHowCore(NamingStrategy naming, List<Loader> loaders, List<Class<? extends BasePropertyGroup>> registeredGroups)

Method Summary

Modifier and Type	Method and Description
List<EffectiveName>	getAliases(Property<?> property) Returns all aliases (in and out) for a property.
String	getCanonicalName(Property<?> prop) Returns the canonical name of a registered property.
<T> T	getEffectiveValue(Property<T> prop) The explicitly value, or if that is null, the default (which may also be null).
<T> T	getExplicitValue(Property<T> prop) Get a value explicitly configured.
List<ExportGroup>	getExportGroups() The list of ExportGroups, which handles exporting property values for use outside the AndHow framework.
Class<? extends BasePropertyGroup>	getGroupForProperty(Property<?> prop) Finds the BasePropertyGroup containing the specified Property.
NamingStrategy	getNamingStrategy() Defines how names are created for Properties.
List<Property<?>>	getProperties() Returns a complete list of all registered properties.
List<Property<?>>	getPropertiesForGroup(Class<? extends BasePropertyGroup> group) Returns a list of Properties registered in the passed group.
Property<?>	getProperty(String name) Finds a registered property by any recognized classpath style name, including the canonical name or 'in' aliases.
List<Class<? extends BasePropertyGroup>>	getPropertyGroups() Returns a list of all registered groups.
Map<String,String>	getSystemEnvironment() Handles access to System.getEnv().
boolean	isExplicitlySet(Property<?> prop) Returns true if the Property's value was explicitly set via one of the loaders.

Methods inherited from class java.lang.Object

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

Constructor Detail

AndHowCore

public AndHowCore(NamingStrategy naming,
                  List<Loader> loaders,
                  List<Class<? extends BasePropertyGroup>> registeredGroups)
           throws AppFatalException

Throws:

AppFatalException

Method Detail

isExplicitlySet

public boolean isExplicitlySet(Property<?> prop)

Description copied from interface: ValueMap

Returns true if the Property's value was explicitly set via one of the loaders. At the moment, that means it would also return a non-null value, however, future versions may support explicit nulls.

Specified by:

isExplicitlySet in interface ValueMap

Parameters:

prop - The property to check

Returns:

True if this value is explicitly set.

getExplicitValue

public <T> T getExplicitValue(Property<T> prop)

Description copied from interface: ValueMap

Get a value explicitly configured. If not configured via one of the Loaders, null is returned, not the default value.

Specified by:

getExplicitValue in interface ValueMap

Type Parameters:

T - prop The property to get the value for

Returns:

The value, if explicitly set, or null if not explicity set.

getEffectiveValue

public <T> T getEffectiveValue(Property<T> prop)

Description copied from interface: ValueMap

The explicitly value, or if that is null, the default (which may also be null).

Specified by:

getEffectiveValue in interface ValueMap

Parameters:

prop - The property to get the value for.

Returns:

The explicit value or, if no explicit, the default value. Otherwise null.

getAliases

public List<EffectiveName> getAliases(Property<?> property)

Description copied from interface: ConstructionDefinition

Returns all aliases (in and out) for a property. This may be different than the aliases requested for the Property, since the application-level configuration has the ability to add and remove aliases to mitigate name conflicts.

Specified by:

getAliases in interface ConstructionDefinition

Parameters:

property - The property to fetch naming information for

Returns:

All aliases available for this property.

getCanonicalName

public String getCanonicalName(Property<?> prop)

Description copied from interface: ConstructionDefinition

Returns the canonical name of a registered property. If the property is not registered, null is returned.

Specified by:

getCanonicalName in interface ConstructionDefinition

Parameters:

prop - The property to get the canonical name for

Returns:

The canonical name

getGroupForProperty

public Class<? extends BasePropertyGroup> getGroupForProperty(Property<?> prop)

Description copied from interface: ConstructionDefinition

Finds the BasePropertyGroup containing the specified Property.

Specified by:

getGroupForProperty in interface ConstructionDefinition

Parameters:

prop - The property to get the PropertyGroup for

Returns:

May return null if the Property is not in any group, or during construction, if the group has not finished registering all of its properties.

getPropertiesForGroup

public List<Property<?>> getPropertiesForGroup(Class<? extends BasePropertyGroup> group)

Description copied from interface: ConstructionDefinition

Returns a list of Properties registered in the passed group. If the group is unregistered or has no properties, an empty list is returned.

Specified by:

getPropertiesForGroup in interface ConstructionDefinition

Parameters:

group - The group to get Properties for

Returns:

An unmodifiable list of Properties

getProperty

public Property<?> getProperty(String name)

Description copied from interface: ConstructionDefinition

Finds a registered property by any recognized classpath style name, including the canonical name or 'in' aliases. Note that this recognizes only classpath style names, not URI style names such as would be used in JNDI. Some loaders, like the JndiLoader will read both the classpath name, like my.property and the URI style name, like my/property. The URI style name is just a means of reading properties in another system - for AndHow the URI style name is not considered an actual name.

Specified by:

getProperty in interface ConstructionDefinition

Parameters:

name - A path to a property in the classpath style.

Returns:

The Property or null if it is not found.

getPropertyGroups

public List<Class<? extends BasePropertyGroup>> getPropertyGroups()

Description copied from interface: ConstructionDefinition

Returns a list of all registered groups.

Specified by:

getPropertyGroups in interface ConstructionDefinition

Returns:

An unmodifiable list of BasePropertyGroups

getProperties

public List<Property<?>> getProperties()

Description copied from interface: ConstructionDefinition

Returns a complete list of all registered properties.

Specified by:

getProperties in interface ConstructionDefinition

Returns:

An unmodifiable list of registered properties.

getExportGroups

public List<ExportGroup> getExportGroups()

Description copied from interface: ConstructionDefinition

The list of ExportGroups, which handles exporting property values for use outside the AndHow framework. An ExportGroup bundles an Exporter implementation with a BasePropertyGroup to be exported. After startup is complete, each Exporter will export its group as configured.

Specified by:

getExportGroups in interface ConstructionDefinition

Returns:

An unmodifiable list of export groups.

getNamingStrategy

public NamingStrategy getNamingStrategy()

Description copied from interface: ConstructionDefinition

Defines how names are created for Properties.

Specified by:

getNamingStrategy in interface ConstructionDefinition

Returns:

The NamingStrategy in use.

getSystemEnvironment

public Map<String,String> getSystemEnvironment()

Description copied from interface: ConstructionDefinition

Handles access to System.getEnv(). Nominally this is the same as calling System.getEnv(), but allows for testing by making it possible to inject values into System.getEnv(). Implementations may also augment or trim down environment variables if needed.

Specified by:

getSystemEnvironment in interface ConstructionDefinition

Returns:

A map containing the system env at the time of startup.