ConstructionDefinitionMutable (AndHow 0.3.0 API)

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

All Implemented Interfaces:

ConstructionDefinition
```
public class ConstructionDefinitionMutable
extends Object
implements ConstructionDefinition
```
A mutable version that can be used during AndHow startup.

Author:

eeverman

Field Summary
- Fields inherited from interface org.yarnandtail.andhow.api.ConstructionDefinition
  EMPTY_PROPERTY_LIST

Constructor Summary

Constructors
Constructor and Description

ConstructionDefinitionMutable(NamingStrategy namingStrategy)

Constructors
Constructor and Description
`ConstructionDefinitionMutable(NamingStrategy namingStrategy)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addExportGroup(ExportGroup exportGroup)`
`ConstructionProblem`	`addProperty(Class<? extends BasePropertyGroup> group, Property<?> property)` Adds a BasePropertyGroup, its Property and the name and aliases for that property to all the collections.
`protected <T> ConstructionProblem.InvalidDefaultValue`	`checkForInvalidDefaultValue(Property<T> property, Class<? extends BasePropertyGroup> group, String canonName)` Checks a Property's default value against its Validators and adds entries to constructProblems if there are issues.
`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.
`List<ExportGroup>`	`getExportGroups()` The list of ExportGroups, which handles exporting property values for use outside the AndHow framework.
`Class<? extends BasePropertyGroup>`	`getGroupForProperty(Property<?> prop)` Finds the BasePropertyGroup 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(Class<? extends BasePropertyGroup> 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<Class<? extends BasePropertyGroup>>`	`getPropertyGroups()` Returns a list of all registered groups.
`Map<String,String>`	`getSystemEnvironment()` Handles access to System.getEnv().
`ConstructionDefinition`	`toImmutable()` Return an immutable instance.

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

- Constructor Detail
  - ConstructionDefinitionMutable
```
public ConstructionDefinitionMutable(NamingStrategy namingStrategy)
```
- Method Detail
  - addProperty
```
public ConstructionProblem addProperty(Class<? extends BasePropertyGroup> group,
                                       Property<?> property)
```
    Adds a BasePropertyGroup, its Property and the name and aliases for that property to all the collections.
    
    Parameters:
    
    group - The BasePropertyGroup parent of the property
    
    property - The Property to be added
  - addExportGroup
```
public void addExportGroup(ExportGroup exportGroup)
```
  - getProperty
```
public Property<?> getProperty(String classpathStyleName)
```
    Description copied from interface: ConstructionDefinition
    
    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 ConstructionDefinition
    
    Parameters:
    
    classpathStyleName - A path to a property in the classpath style.
    
    Returns:
    
    The Property or null if it is not found.
  - getAliases
```
public List<EffectiveName> getAliases(Property<?> property)
```
    Description copied from interface: ConstructionDefinition
    
    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 ConstructionDefinition
    
    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: ConstructionDefinition
    
    Returns the canonical name of a registered property. If the property is not registered, null is returned.
    
    Specified by:
    
    getCanonicalName in interface ConstructionDefinition
    
    Parameters:
    
    prop - The property to get the canonical name for
    
    Returns:
    
    The canonical name
  - getProperties
```
public List<Property<?>> getProperties()
```
    Description copied from interface: ConstructionDefinition
    
    Returns a complete list of all registered properties.
    
    Specified by:
    
    getProperties in interface ConstructionDefinition
    
    Returns:
    
    An unmodifiable list of registered properties.
  - getPropertyGroups
```
public List<Class<? extends BasePropertyGroup>> getPropertyGroups()
```
    Description copied from interface: ConstructionDefinition
    
    Returns a list of all registered groups.
    
    Specified by:
    
    getPropertyGroups in interface ConstructionDefinition
    
    Returns:
    
    An unmodifiable list of BasePropertyGroups
  - getPropertiesForGroup
```
public List<Property<?>> getPropertiesForGroup(Class<? extends BasePropertyGroup> group)
```
    Description copied from interface: ConstructionDefinition
    
    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 ConstructionDefinition
    
    Parameters:
    
    group - The group to get Properties for
    
    Returns:
    
    An unmodifiable list of Properties
  - getGroupForProperty
```
public Class<? extends BasePropertyGroup> getGroupForProperty(Property<?> prop)
```
    Description copied from interface: ConstructionDefinition
    
    Finds the BasePropertyGroup containing the specified Property.
    
    Specified by:
    
    getGroupForProperty in interface ConstructionDefinition
    
    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.
  - getExportGroups
```
public List<ExportGroup> getExportGroups()
```
    Description copied from interface: ConstructionDefinition
    
    The list of ExportGroups, which handles exporting property values for use outside the AndHow framework. An ExportGroup bundles an Exporter implementation with a BasePropertyGroup to be exported. After startup is complete, each Exporter will export its group as configured.
    
    Specified by:
    
    getExportGroups in interface ConstructionDefinition
    
    Returns:
    
    An unmodifiable list of export groups.
  - getNamingStrategy
```
public NamingStrategy getNamingStrategy()
```
    Description copied from interface: ConstructionDefinition
    
    Defines how names are created for Properties.
    
    Specified by:
    
    getNamingStrategy in interface ConstructionDefinition
    
    Returns:
    
    The NamingStrategy in use.
  - getSystemEnvironment
```
public Map<String,String> getSystemEnvironment()
```
    Description copied from interface: ConstructionDefinition
    
    Handles access to System.getEnv(). Nominally this is the same as calling System.getEnv(), but allows for testing by making it possible to inject values into System.getEnv(). Implementations may also augment or trim down environment variables if needed.
    
    Specified by:
    
    getSystemEnvironment in interface ConstructionDefinition
    
    Returns:
    
    A map containing the system env at the time of startup.
  - checkForInvalidDefaultValue
```
protected final <T> ConstructionProblem.InvalidDefaultValue checkForInvalidDefaultValue(Property<T> property,
                                                                                        Class<? extends BasePropertyGroup> group,
                                                                                        String canonName)
```
    Checks a Property's default value against its Validators and adds entries to constructProblems if there are issues.
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    property -
    
    group -
    
    canonName -
    
    Returns:
    
    True if the default value is invalid.
  - toImmutable
```
public ConstructionDefinition toImmutable()
```
    Return an immutable instance.
    
    Returns:

Class ConstructionDefinitionMutable

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConstructionDefinitionMutable

Method Detail

addProperty

addExportGroup

getProperty

getAliases

getCanonicalName

getProperties

getPropertyGroups

getPropertiesForGroup

getGroupForProperty

getExportGroups

getNamingStrategy

getSystemEnvironment

checkForInvalidDefaultValue

toImmutable