AndHow (andhow 0.4.0-RC5 API)

java.lang.Object
- org.yarnandtail.andhow.AndHow

All Implemented Interfaces:

StaticPropertyConfiguration, ValidatedValues
```
public class AndHow
extends Object
implements StaticPropertyConfiguration, ValidatedValues
```
Central AndHow singleton class. This class is not directly constructed. The primary way to configure an instance is indirectly by creating a subclass of org.yarnandtail.andhow.AndHowInit. At startup, AndHow discovers your AndHowInit implementation and uses it to configure a single instance. For cases where the application needs to accept command line arguments or augment the configuration with fixed values, the configuration can have those parameters added like this:
```
 AndHow.findConfig().setCmdLineArgs(myCmdLineArgs).build();
 
```
findConfig() finds the AndHowConfiguration that would be used if AndHow.instance() was called. build() then causes the AndHow instance to be built with that modified configuration. The code above (or any method of AndHow initiation) can only be executed once during the life of the application.
Author:

eeverman

Field Summary

Fields
Modifier and Type Field and Description

static String ANDHOW_INLINE_NAME

static String ANDHOW_NAME

static String ANDHOW_TAG_LINE

static String ANDHOW_URL
- Fields inherited from interface org.yarnandtail.andhow.api.StaticPropertyConfiguration
  EMPTY_PROPERTY_LIST

Fields
Modifier and Type	Field and Description
`static String`	`ANDHOW_INLINE_NAME`
`static String`	`ANDHOW_NAME`
`static String`	`ANDHOW_TAG_LINE`
`static String`	`ANDHOW_URL`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`containsUserGroups()` Returns true if any of the registered groups are user groups.
`static AndHowConfiguration<? extends AndHowConfiguration>`	`findConfig()` Finds and creates a new instance of the `AndHowConfiguration` that would be used if `AndHow.instance()` was called.
`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.
`<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, similar to Property.getValue, but specifically for the context of this ValueMap.
`static AndHow`	`instance()` Returns the current AndHow instance.
`static AndHow`	`instance(AndHowConfiguration config)` Builds a new AndHow instance using the specified configuration ONLY IF there is no existing AndHow instance.
`boolean`	`isExplicitlySet(Property<?> prop)` Returns true if the Property's value was explicitly set to a non-null value via one of the loaders.
`static boolean`	`isInitialize()` Determine if AndHow is initialized or not w/out forcing AndHow to load.

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

- Field Detail
  - ANDHOW_INLINE_NAME
```
public static final String ANDHOW_INLINE_NAME
```
    See Also:
    
    Constant Field Values
  - ANDHOW_NAME
```
public static final String ANDHOW_NAME
```
    See Also:
    
    Constant Field Values
  - ANDHOW_URL
```
public static final String ANDHOW_URL
```
    See Also:
    
    Constant Field Values
  - ANDHOW_TAG_LINE
```
public static final String ANDHOW_TAG_LINE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - findConfig
```
public static AndHowConfiguration<? extends AndHowConfiguration> findConfig()
```
    Finds and creates a new instance of the AndHowConfiguration that would be used if AndHow.instance() was called. Note: If AndHow.instance() is later called, a new AndHowConfiguration will be returned, not this same instance.
    This method provides a way to add command line parameters or fixed values to the existing configuration and then immediately initiate AndHow.
    Example usage:
```
 AndHow.findConfig().setCmdLineArgs(myCmdLineArgs).build();
 
```
    The call to build() at the end of that command string is just a convenience method to call AndHow.instance(thisConfiguration);
    Returns:
  - instance
```
public static AndHow instance()
                       throws AppFatalException
```
    Returns the current AndHow instance. If there is no instance, one is created using auto-discovered configuration.
    
    Returns:
    
    Throws:
    
    AppFatalException
  - instance
```
public static AndHow instance(AndHowConfiguration config)
                       throws AppFatalException
```
    Builds a new AndHow instance using the specified configuration ONLY IF there is no existing AndHow instance. A fatal RuntimeException will be thrown if there is an existing AndHow instance. This method does not normally need to be used to initiate AndHow. See the AndHow class docs for typical configuration examples.
    
    Parameters:
    
    config -
    
    Returns:
    
    Throws:
    
    AppFatalException
  - isInitialize
```
public static boolean isInitialize()
```
    Determine if AndHow is initialized or not w/out forcing AndHow to load.
    
    Returns:
  - isExplicitlySet
```
public boolean isExplicitlySet(Property<?> prop)
```
    Description copied from interface: ValidatedValues
    
    Returns true if the Property's value was 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)
```
    Description copied from interface: ValidatedValues
    
    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.
    
    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.
  - getValue
```
public <T> T getValue(Property<T> prop)
```
    Description copied from interface: ValidatedValues
    
    The effective value, similar to Property.getValue, but specifically for the context of this ValueMap. The effective value is the explicitly configured value, or if that is null, the default value. Explicitly setting a property to null is not possible because it will just be ignored and the default used instead.
    
    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.
  - 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
  - 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.
  - 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
  - getProperty
```
public Property<?> getProperty(String name)
```
    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:
    
    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: 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:
  - 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.
  - 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.

Class AndHow

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ANDHOW_INLINE_NAME

ANDHOW_NAME

ANDHOW_URL

ANDHOW_TAG_LINE

Method Detail

findConfig

instance

instance

isInitialize

isExplicitlySet

getExplicitValue

getValue

getAliases

getCanonicalName

getGroupForProperty

getPropertiesForGroup

getProperty

getPropertyGroups

containsUserGroups

getProperties

getExportGroups

getNamingStrategy