org.yarnandtail.andhow.api

Interface ConstructionDefinition

All Known Implementing Classes:

AndHow, AndHowCore, ConstructionDefinitionImmutable, ConstructionDefinitionMutable

public interface ConstructionDefinition

The defined set and metadata related to the PropertyGroups, Properties and associated names that are in scope for an initialized AndHow instance. This definition does not include the actual values configured for the Properties or Loaders. This interface is analogous to the list of declared fields. The values assigned to those fields is analogous to the ValueMap interface.

Author:

eeverman

Field Summary

Fields

Modifier and Type	Field and Description
static List<Property<?>>	EMPTY_PROPERTY_LIST

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.
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 classpathStyleName) 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().

Field Detail

EMPTY_PROPERTY_LIST

static final List<Property<?>> EMPTY_PROPERTY_LIST

Method Detail

getAliases

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

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.

Parameters:

property - The property to fetch naming information for

Returns:

All aliases available for this property.

getCanonicalName

String getCanonicalName(Property<?> prop)

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

Parameters:

prop - The property to get the canonical name for

Returns:

The canonical name

getGroupForProperty

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

Finds the BasePropertyGroup containing the specified Property.

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.

getProperties

List<Property<?>> getProperties()

Returns a complete list of all registered properties.

Returns:

An unmodifiable list of registered properties.

getPropertiesForGroup

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

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

Parameters:

group - The group to get Properties for

Returns:

An unmodifiable list of Properties

getPropertyGroups

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

Returns a list of all registered groups.

Returns:

An unmodifiable list of BasePropertyGroups

getProperty

Property<?> getProperty(String classpathStyleName)

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.

Parameters:

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

Returns:

The Property or null if it is not found.

getExportGroups

List<ExportGroup> getExportGroups()

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.

Returns:

An unmodifiable list of export groups.

getNamingStrategy

NamingStrategy getNamingStrategy()

Defines how names are created for Properties.

Returns:

The NamingStrategy in use.

getSystemEnvironment

Map<String,String> getSystemEnvironment()

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.

Returns:

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