org.yarnandtail.andhow.internal

Class AndHowCore

java.lang.Object

org.yarnandtail.andhow.internal.AndHowCore

All Implemented Interfaces:

StaticPropertyConfiguration, ValidatedValues

public class AndHowCore
extends Object
implements StaticPropertyConfiguration, ValidatedValues

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.StaticPropertyConfiguration

EMPTY_PROPERTY_LIST

Constructor Summary

Constructors

Constructor and Description
AndHowCore(NamingStrategy naming, List<Loader> loaders, List<GroupProxy> registeredGroups)

Method Summary

Modifier and Type	Method and Description
boolean	containsUserGroups() Returns true if any of the registered groups are user groups.
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	getExplicitValue(Property<T> prop) The value found and loaded for this value by a Loader.
List<ExportGroup>	getExportGroups() The list of ExportGroups, which handles exporting property values for use outside the AndHow framework.
GroupProxy	getGroupForProperty(Property<?> prop) Finds the Group 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(GroupProxy 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<GroupProxy>	getPropertyGroups() Returns a list of all registered groups.
<T> T	getValue(Property<T> prop) The effective value, similar to Property.getValue, but specifically for the context of this ValueMap.
boolean	isExplicitlySet(Property<?> prop) Returns true if the Property's value was explicitly set to a non-null value 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<GroupProxy> registeredGroups)
           throws AppFatalException

Throws:

AppFatalException

Method Detail

isExplicitlySet

public boolean isExplicitlySet(Property<?> prop)

Description copied from interface: ValidatedValues

Returns true if the Property's value was explicitly set to a non-null value via one of the loaders.

Specified by:

isExplicitlySet in interface ValidatedValues

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: ValidatedValues

The value found and loaded for this value by a Loader. If no non-null value was found by a loader for this property, null is returned.

Specified by:

getExplicitValue in interface ValidatedValues

Type Parameters:

T - The return type of the Property.

Parameters:

prop - The property to get the value for

Returns:

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

getValue

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

Description copied from interface: ValidatedValues

The effective value, similar to Property.getValue, but specifically for the context of this ValueMap. The effective value is the explicitly configured value, or if that is null, the default value. Explicitly setting a property to null is not possible because it will just be ignored and the default used instead.

Specified by:

getValue in interface ValidatedValues

Type Parameters:

T - The return type of the Property.

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: StaticPropertyConfiguration

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 StaticPropertyConfiguration

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: StaticPropertyConfiguration

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

Specified by:

getCanonicalName in interface StaticPropertyConfiguration

Parameters:

prop - The property to get the canonical name for

Returns:

The canonical name

getGroupForProperty

public GroupProxy getGroupForProperty(Property<?> prop)

Description copied from interface: StaticPropertyConfiguration

Finds the Group containing the specified Property.

Specified by:

getGroupForProperty in interface StaticPropertyConfiguration

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(GroupProxy group)

Description copied from interface: StaticPropertyConfiguration

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 StaticPropertyConfiguration

Parameters:

group - The group to get Properties for

Returns:

An unmodifiable list of Properties

getProperty

public Property<?> getProperty(String name)

Description copied from interface: StaticPropertyConfiguration

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 StaticPropertyConfiguration

Parameters:

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

Returns:

The Property or null if it is not found.

getPropertyGroups

public List<GroupProxy> getPropertyGroups()

Description copied from interface: StaticPropertyConfiguration

Returns a list of all registered groups.

Specified by:

getPropertyGroups in interface StaticPropertyConfiguration

Returns:

An unmodifiable list of Groups

containsUserGroups

public boolean containsUserGroups()

Description copied from interface: StaticPropertyConfiguration

Returns true if any of the registered groups are user groups. False would indicate that no user groups were found or explicitly registered.

Specified by:

containsUserGroups in interface StaticPropertyConfiguration

Returns:

getProperties

public List<Property<?>> getProperties()

Description copied from interface: StaticPropertyConfiguration

Returns a complete list of all registered properties.

Specified by:

getProperties in interface StaticPropertyConfiguration

Returns:

An unmodifiable list of registered properties.

getExportGroups

public List<ExportGroup> getExportGroups()

Description copied from interface: StaticPropertyConfiguration

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

Specified by:

getExportGroups in interface StaticPropertyConfiguration

Returns:

An unmodifiable list of export groups.

getNamingStrategy

public NamingStrategy getNamingStrategy()

Description copied from interface: StaticPropertyConfiguration

Defines how names are created for Properties.

Specified by:

getNamingStrategy in interface StaticPropertyConfiguration

Returns:

The NamingStrategy in use.