org.yarnandtail.andhow.api

Interface StaticPropertyConfiguration

All Known Subinterfaces:

StaticPropertyConfigurationInternal

All Known Implementing Classes:

AndHow, AndHowCore, StaticPropertyConfigurationImmutable, StaticPropertyConfigurationMutable

public interface StaticPropertyConfiguration

Public view of configuration and metadata for all known static Properties. This is the entire domain of Properties defined as static properties (ie the property is defined as a static variable) and on the classpath (or explicitly configured) to be part of AndHow in the current classloader.
This definition does not include the actual values configured for the Properties - That is in the ValidatedValues interface.
Note that it is not possible to list all known Properties or look them up by name or group. This is intentional to enforce security. Property declarations follow Java visibility rules, so you must have the reference to the actual property to look up information or values for that property. For instance, this property:
private static final StrProp FOO = StrProp.builder().build();
Is declared as private. If any part of the public AndHow API provides an alternate path to access the property and read its value, it would bypass the intended visibility of the property.

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.
GroupProxy	getGroupForProperty(Property<?> prop) Finds the Group containing the specified Property.
NamingStrategy	getNamingStrategy() Defines how names are created for Properties.

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

GroupProxy getGroupForProperty(Property<?> prop)

Finds the Group 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.

getNamingStrategy

NamingStrategy getNamingStrategy()

Defines how names are created for Properties.

Returns:

The NamingStrategy in use.