org.yarnandtail.andhow.util

Class AndHowUtil

java.lang.Object

org.yarnandtail.andhow.util.AndHowUtil

public class AndHowUtil
extends Object

Utilities used by AndHow during initial construction.

Author:

eeverman

Constructor Summary

Constructors

Constructor and Description
AndHowUtil()

Method Summary

Modifier and Type	Method and Description
static ConstructionDefinitionMutable	buildDefinition(List<Class<? extends BasePropertyGroup>> groups, List<Loader> loaders, NamingStrategy naming, ProblemList<Problem> problems) Build a fully populated ConstructionDefinition from the passed Groups, using the NamingStrategy to generate names for each.
static AppFatalException	buildFatalException(ProblemList<Problem> problems)
static String	getCanonicalName(Class<? extends BasePropertyGroup> group, Property<?> property) Gets the true canonical name for a Property in the group.
static List<Exporter>	getExporters(Class<? extends BasePropertyGroup> group) Returns the list of Exporters that are annotated for a BasePropertyGroup.
static String	getFieldName(Class<? extends BasePropertyGroup> group, Property<?> property) Gets the field name for a property in the group, which is just the last portion of the canonical name.
static List<NameAndProperty>	getProperties(Class<? extends BasePropertyGroup> group) Builds a list of all Properties and their field names contained in the passed group.
static void	printExceptions(List<? extends Exception> exceptions, PrintStream out)
protected static ProblemList<ConstructionProblem>	registerGroup(ConstructionDefinitionMutable appDef, Class<? extends BasePropertyGroup> group)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AndHowUtil

public AndHowUtil()

Method Detail

buildDefinition

public static ConstructionDefinitionMutable buildDefinition(List<Class<? extends BasePropertyGroup>> groups,
                                                            List<Loader> loaders,
                                                            NamingStrategy naming,
                                                            ProblemList<Problem> problems)

Build a fully populated ConstructionDefinition from the passed Groups, using the NamingStrategy to generate names for each.

Parameters:

groups - The PropertyGroups from which to find Properties. May be null.

loaders - The Loaders, which may their own configurable PropertyGroups.

naming - A naming strategy to use when reading the properties during loading

problems - If construction problems are found, add to this list.

Returns:

A fully configured instance

registerGroup

protected static ProblemList<ConstructionProblem> registerGroup(ConstructionDefinitionMutable appDef,
                                                                Class<? extends BasePropertyGroup> group)

printExceptions

public static void printExceptions(List<? extends Exception> exceptions,
                                   PrintStream out)

buildFatalException

public static AppFatalException buildFatalException(ProblemList<Problem> problems)

getExporters

public static List<Exporter> getExporters(Class<? extends BasePropertyGroup> group)
                                   throws InstantiationException,
                                          IllegalAccessException

Returns the list of Exporters that are annotated for a BasePropertyGroup.

Parameters:

group -

Returns:

Throws:

InstantiationException

IllegalAccessException

getProperties

public static List<NameAndProperty> getProperties(Class<? extends BasePropertyGroup> group)
                                           throws IllegalArgumentException,
                                                  IllegalAccessException,
                                                  SecurityException

Builds a list of all Properties and their field names contained in the passed group. Exceptions may be thrown if a security manager blocks access to members.

Parameters:

group -

Returns:

Throws:

IllegalArgumentException

IllegalAccessException

SecurityException

getFieldName

public static String getFieldName(Class<? extends BasePropertyGroup> group,
                                  Property<?> property)
                           throws IllegalArgumentException,
                                  IllegalAccessException,
                                  SecurityException

Gets the field name for a property in the group, which is just the last portion of the canonical name. The canonical name is of the form:
[group canonical name].[field name of the Property within the group]
thus, it is require that the Property be a field within the group, otherwise null is returned. Exceptions may be thrown if a security manager blocks access to members.

Parameters:

group -

property -

Returns:

Throws:

IllegalArgumentException

IllegalAccessException

SecurityException

getCanonicalName

public static String getCanonicalName(Class<? extends BasePropertyGroup> group,
                                      Property<?> property)
                               throws IllegalArgumentException,
                                      IllegalAccessException,
                                      SecurityException

Gets the true canonical name for a Property in the group. The canonical name is of the form:
[group canonical name].[field name of the Property within the group]
thus, it is require that the Property be a field within the group, otherwise null is returned. Exceptions may be thrown if a security manager blocks access to members. Technically the NameingStrategy is in charge of generating names, but the canonical name never changes and is based on the package path of a Property within a BasePropertyGroup.

Parameters:

group -

property -

Returns:

Throws:

IllegalArgumentException

IllegalAccessException

SecurityException