org.yarnandtail.andhow.internal

Class StaticPropertyConfigurationImmutable

java.lang.Object

org.yarnandtail.andhow.internal.StaticPropertyConfigurationImmutable

All Implemented Interfaces:

StaticPropertyConfiguration

public class StaticPropertyConfigurationImmutable
extends Object
implements StaticPropertyConfiguration

An immutable instance that can be used during runtime.

Author:

eeverman

Field Summary

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

EMPTY_PROPERTY_LIST

Constructor Summary

Constructors

Constructor and Description
StaticPropertyConfigurationImmutable(NamingStrategy namingStrategy, List<GroupProxy> groupList, List<Property<?>> properties, Map<GroupProxy,List<Property<?>>> propertiesByGroup, Map<String,Property<?>> propertiesByAnyName, Map<Property<?>,List<EffectiveName>> aliasesByProperty, Map<Property<?>,String> canonicalNameByProperty, List<ExportGroup> exportGroups)

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

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticPropertyConfigurationImmutable

public StaticPropertyConfigurationImmutable(NamingStrategy namingStrategy,
                                            List<GroupProxy> groupList,
                                            List<Property<?>> properties,
                                            Map<GroupProxy,List<Property<?>>> propertiesByGroup,
                                            Map<String,Property<?>> propertiesByAnyName,
                                            Map<Property<?>,List<EffectiveName>> aliasesByProperty,
                                            Map<Property<?>,String> canonicalNameByProperty,
                                            List<ExportGroup> exportGroups)

Method Detail

getProperty

public Property<?> getProperty(String classpathStyleName)

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:

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

Returns:

The Property or null if it is not found.

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

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.

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:

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

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.

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.