org.yarnandtail.andhow.api

Interface PropertyConfiguration

All Known Subinterfaces:

PropertyConfigurationInternal

All Known Implementing Classes:

AndHow, AndHowCore, PropertyConfigurationImmutable, PropertyConfigurationMutable

public interface PropertyConfiguration

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) All the effective 'in' & 'out' aliases for this property, not including the canonical name.
String	getCanonicalName(Property<?> prop) The canonical name of a Property.
NamingStrategy	getNamingStrategy() Defines how names are created for Properties.

Method Detail

getAliases

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

All the effective 'in' & 'out' aliases for this property, not including the canonical name.

The returned aliases may differ from the original requested aliases in two ways:

• NamingStrategy may modify 'In' aliases, e.g. convert them to uppercase for case-insensitive matching. This method returns the modified 'In' aliases.
• Aliases may be coalesced if: If an 'In' alias matches an 'Out' alias, a single 'InAndOut' alias may be returned.

Parameters:

property - The property to fetch naming information for

Returns:

A non-null, non-modifiable list of alias EffectiveNames for this Property.

See Also:

Property.getInAliases(), Property.getOutAliases(), Property.getRequestedAliases()

getCanonicalName

String getCanonicalName(Property<?> prop)

The canonical name of a Property.

Canonical Property names are the full Java classname of the class containing the Property, plus the Property name, e.g. org.acme.myapp.MyClass.MyProperty. Properties contained in inner classes and interfaces continue the same naming structure, e.g. org.acme.myapp.MyClass.MyInnerClass.MyInnerInterface.MyProperty.

Parameters:

prop - The Property to get the canonical name for.

Returns:

The canonical name of the Property.

getNamingStrategy

NamingStrategy getNamingStrategy()

Defines how names are created for Properties.

Returns:

The NamingStrategy in use.