org.yarnandtail.andhow.internal

Interface StaticPropertyConfigurationInternal

All Superinterfaces:

StaticPropertyConfiguration

All Known Implementing Classes:

AndHowCore, StaticPropertyConfigurationImmutable, StaticPropertyConfigurationMutable

public interface StaticPropertyConfigurationInternal
extends StaticPropertyConfiguration

Provides a complete view of all known Properties. This extends the public view of properties from StaticPropertyConfiguration and adds the ability to work the entire list of properties. This is an internal-only API because that property list must never be made public or it would bypass the security of limited visibility Properties.

See Also:

StaticPropertyConfiguration

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
boolean	containsUserGroups() Returns true if any of the registered groups are user groups.
List<ExportGroup>	getExportGroups() The list of ExportGroups, which handles exporting property values for use outside the AndHow framework.
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 interface org.yarnandtail.andhow.api.StaticPropertyConfiguration

getAliases, getCanonicalName, getGroupForProperty, getNamingStrategy

Field Detail

EMPTY_PROPERTY_LIST

static final List<Property<?>> EMPTY_PROPERTY_LIST

Method Detail

getProperties

List<Property<?>> getProperties()

Returns a complete list of all registered properties.

Returns:

An unmodifiable list of registered properties.

containsUserGroups

boolean containsUserGroups()

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

Returns:

getPropertiesForGroup

List<Property<?>> getPropertiesForGroup(GroupProxy 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<GroupProxy> getPropertyGroups()

Returns a list of all registered groups.

Returns:

An unmodifiable list of Groups

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 Group to be exported. After startup is complete, each Exporter will export its group as configured.

Returns:

An unmodifiable list of export groups.