AndHowCore (AndHow Annotation Processor 1.5.0 API)

java.lang.Object
- org.yarnandtail.andhow.internal.AndHowCore

All Implemented Interfaces:

PropertyConfiguration, ValidatedValues, PropertyConfigurationInternal
```
public class AndHowCore
extends Object
implements PropertyConfigurationInternal, ValidatedValues
```
Actual central instance of AndHow's state after a successful initialization.
The AndHow class is really a proxy for this class, which allows abstraction of the implementation and re-initialization during unit testing by swapping out the AndHowCore implementation while maintaining the AndHow singleton so references to it are stable.

Field Summary
- Fields inherited from interface org.yarnandtail.andhow.internal.PropertyConfigurationInternal
  EMPTY_PROPERTY_LIST

Constructor Summary

Constructors
Constructor and Description
`AndHowCore(NamingStrategy naming, List<Loader> loaders, LoaderEnvironment loaderEnvironment, List<GroupProxy> registeredGroups)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`checkForValuesWhichMustBeNonNull(PropertyConfigurationInternal config, ValidatedValues values, ProblemList<Problem> problems)` Adds a NonNullPropertyProblem for each null valued Property that is required to be non-null.
`boolean`	`containsUserGroups()` Returns true if any of the registered groups are user groups.
`Stream<PropertyExport>`	`export(Class<?>... exportClasses)`
`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`.
`<T> T`	`getExplicitValue(Property<T> prop)` The value found and loaded for this value by a Loader.
`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 name)` 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.
`<T> T`	`getValue(Property<T> prop)` The effective value of the Property.
`boolean`	`isExplicitlySet(Property<?> prop)` True if the Property's value is explicitly set to a non-null value via one of the loaders.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AndHowCore
```
public AndHowCore(NamingStrategy naming,
                  List<Loader> loaders,
                  LoaderEnvironment loaderEnvironment,
                  List<GroupProxy> registeredGroups)
           throws AppFatalException
```
    Throws:
    
    AppFatalException
- Method Detail
  - checkForValuesWhichMustBeNonNull
```
public static void checkForValuesWhichMustBeNonNull(PropertyConfigurationInternal config,
                                                    ValidatedValues values,
                                                    ProblemList<Problem> problems)
```
    Adds a NonNullPropertyProblem for each null valued Property that is required to be non-null.
    All parameters are required to be non-null and will throw a null-pointer otherwise.
    
    Parameters:
    
    config - Configuration and metadata for all known Properties
    
    values - Values loaded for the Properties
    
    problems - A list of Problems to append to
  - export
```
public Stream<PropertyExport> export(Class<?>... exportClasses)
                              throws IllegalAccessException
```
    Throws:
    
    IllegalAccessException
  - isExplicitlySet
```
public boolean isExplicitlySet(Property<?> prop)
```
    Description copied from interface: ValidatedValues
    
    True if the Property's value is explicitly set to a non-null value via one of the loaders.
    
    Specified by:
    
    isExplicitlySet in interface ValidatedValues
    
    Parameters:
    
    prop - The property to check
    
    Returns:
    
    True if this value is explicitly set.
  - getExplicitValue
```
public <T> T getExplicitValue(Property<T> prop)
                       throws AndHowIllegalStateException.UnrecognizedPropertyException
```
    The value found and loaded for this value by a Loader.
    If no non-null value was found by a loader for this property, null is returned. If the Property is not recognized, an IllegalArgumentException is thrown. In normal usage, AndHow would not expect an unrecognized Property, so this would indicate an unrecoverable state.
    
    Specified by:
    
    getExplicitValue in interface ValidatedValues
    
    Type Parameters:
    
    T - The return type of the Property.
    
    Parameters:
    
    prop - The property to get the value for
    
    Returns:
    
    The value, if explicitly set, or null if not explicity set.
    
    Throws:
    
    AndHowIllegalStateException.UnrecognizedPropertyException - if the Property is not recognized by AndHow.
  - getValue
```
public <T> T getValue(Property<T> prop)
               throws AndHowIllegalStateException.UnrecognizedPropertyException
```
    The effective value of the Property.
    The effective value is the explicitly configured value, or if that is null, the default value. If the Property is not recognized, an IllegalArgumentException is thrown. In normal usage, AndHow would not expect an unrecognized Property, so this would indicate an unrecoverable state.
    
    Specified by:
    
    getValue in interface ValidatedValues
    
    Type Parameters:
    
    T - The return type of the Property.
    
    Parameters:
    
    prop - The property to get the value for.
    
    Returns:
    
    The explicit value or, if no explicit, the default value. Otherwise null.
    
    Throws:
    
    AndHowIllegalStateException.UnrecognizedPropertyException - if the Property is not recognized by AndHow.
  - getAliases
```
public List<EffectiveName> getAliases(Property<?> property)
```
    Description copied from interface: PropertyConfiguration
    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.
    Specified by:
    
    getAliases in interface PropertyConfiguration
    
    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
```
public String getCanonicalName(Property<?> prop)
```
    Description copied from interface: PropertyConfiguration
    
    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.
    
    Specified by:
    
    getCanonicalName in interface PropertyConfiguration
    
    Parameters:
    
    prop - The Property to get the canonical name for.
    
    Returns:
    
    The canonical name of the Property.
  - getGroupForProperty
```
public GroupProxy getGroupForProperty(Property<?> prop)
```
    Description copied from interface: PropertyConfigurationInternal
    
    Finds the Group containing the specified Property.
    
    Specified by:
    
    getGroupForProperty in interface PropertyConfigurationInternal
    
    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.
  - getPropertiesForGroup
```
public List<Property<?>> getPropertiesForGroup(GroupProxy group)
```
    Description copied from interface: PropertyConfigurationInternal
    
    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 PropertyConfigurationInternal
    
    Parameters:
    
    group - The group to get Properties for
    
    Returns:
    
    An unmodifiable list of Properties
  - getProperty
```
public Property<?> getProperty(String name)
```
    Description copied from interface: PropertyConfigurationInternal
    
    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 PropertyConfigurationInternal
    
    Parameters:
    
    name - A path to a property in the classpath style.
    
    Returns:
    
    The Property or null if it is not found.
  - getPropertyGroups
```
public List<GroupProxy> getPropertyGroups()
```
    Description copied from interface: PropertyConfigurationInternal
    
    Returns a list of all registered groups.
    
    Specified by:
    
    getPropertyGroups in interface PropertyConfigurationInternal
    
    Returns:
    
    An unmodifiable list of Groups
  - containsUserGroups
```
public boolean containsUserGroups()
```
    Description copied from interface: PropertyConfigurationInternal
    
    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 PropertyConfigurationInternal
    
    Returns:
  - getProperties
```
public List<Property<?>> getProperties()
```
    Description copied from interface: PropertyConfigurationInternal
    
    Returns a complete list of all registered properties.
    
    Specified by:
    
    getProperties in interface PropertyConfigurationInternal
    
    Returns:
    
    An unmodifiable list of registered properties.
  - getExportGroups
```
public List<ExportGroup> getExportGroups()
```
    Description copied from interface: PropertyConfigurationInternal
    
    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 PropertyConfigurationInternal
    
    Returns:
    
    An unmodifiable list of export groups.
  - getNamingStrategy
```
public NamingStrategy getNamingStrategy()
```
    Description copied from interface: PropertyConfiguration
    
    Defines how names are created for Properties.
    
    Specified by:
    
    getNamingStrategy in interface PropertyConfiguration
    
    Returns:
    
    The NamingStrategy in use.

Class AndHowCore

Field Summary

Fields inherited from interface org.yarnandtail.andhow.internal.PropertyConfigurationInternal

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AndHowCore

Method Detail

checkForValuesWhichMustBeNonNull

export

isExplicitlySet

getExplicitValue

getValue

getAliases

getCanonicalName

getGroupForProperty

getPropertiesForGroup

getProperty

getPropertyGroups

containsUserGroups

getProperties

getExportGroups

getNamingStrategy