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.

Constructor Summary

Constructors

Constructor and Description
AndHowUtil()

Method Summary

Modifier and Type	Method and Description
static PropertyConfigurationMutable	buildDefinition(List<GroupProxy> 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 List<GroupProxy>	buildGroupProxies(Collection<Class<?>> registeredGroups)
static GroupProxy	buildGroupProxy(Class<?> group) Invokes buildGroupProxy(group, true).
static GroupProxy	buildGroupProxy(Class<?> group, boolean userGroup) Wraps a class that contains AndHow Properties in Proxy class for use within AndHow.
static boolean	classExists(String className) Returns true if the specified class name is on the classpath.
static AndHowConfiguration<? extends AndHowConfiguration>	findConfiguration(AndHowConfiguration<? extends AndHowConfiguration> defaultConfig)
static Method	findMethod(Class<?> target, String name, Class<?>... parameterTypes) Hunts up the inheritance tree to find the specified method.
static Class<?>	getClassForName(String className) Loads a class by name with no errors, returning null if the class cannot be found.
static Object	getClassInstanceForName(String className) Creates a new Object instance from the named class using the default no-arg constructor.
static List<Exporter>	getExporters(GroupProxy group) Returns the list of Exporters that are annotated for a BasePropertyGroup.
static String	getFieldName(Class<?> group, Property<?> property) Gets the field name for a property in a class, which is just the last portion of the canonical name.
static List<NameAndProperty>	getProperties(Class<?> group) Builds a list of all Properties and their field names contained in the passed class.
protected static ProblemList<ConstructionProblem>	registerGroup(PropertyConfigurationMutable appDef, GroupProxy 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 PropertyConfigurationMutable buildDefinition(List<GroupProxy> 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(PropertyConfigurationMutable appDef,
                                                                GroupProxy group)

buildFatalException

public static AppFatalException buildFatalException(ProblemList<Problem> problems)

getExporters

public static List<Exporter> getExporters(GroupProxy group)
                                   throws InstantiationException,
                                          IllegalAccessException,
                                          NoSuchMethodException,
                                          InvocationTargetException

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

Parameters:

group -

Returns:

Throws:

InstantiationException

IllegalAccessException

NoSuchMethodException

InvocationTargetException

getProperties

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

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

Parameters:

group -

Returns:

Throws:

IllegalArgumentException

IllegalAccessException

SecurityException

buildGroupProxy

public static GroupProxy buildGroupProxy(Class<?> group)
                                  throws IllegalArgumentException,
                                         IllegalAccessException,
                                         SecurityException

Invokes buildGroupProxy(group, true).

Parameters:

group -

Returns:

Throws:

IllegalArgumentException

IllegalAccessException

SecurityException

buildGroupProxy

public static GroupProxy buildGroupProxy(Class<?> group,
                                         boolean userGroup)
                                  throws IllegalArgumentException,
                                         IllegalAccessException,
                                         SecurityException

Wraps a class that contains AndHow Properties in Proxy class for use within AndHow. A user specified group is the 'standard' type of group where are user creates a property and that class containing that property is then registered as a group. A non-userGroup one which is added automatically by AndHow to configure AndHow itself or one of the loaders.

Parameters:

group -

userGroup - If true, this group is a user specified group

Returns:

Throws:

IllegalArgumentException

IllegalAccessException

SecurityException

buildGroupProxies

public static List<GroupProxy> buildGroupProxies(Collection<Class<?>> registeredGroups)
                                          throws AppFatalException

Throws:

AppFatalException

getFieldName

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

Gets the field name for a property in a class, which is just the last portion of the canonical name. Exceptions may be thrown if a security manager blocks access to members.

Parameters:

group -

property -

Returns:

Throws:

IllegalArgumentException

IllegalAccessException

SecurityException

findMethod

public static Method findMethod(Class<?> target,
                                String name,
                                Class<?>... parameterTypes)
                         throws SecurityException

Hunts up the inheritance tree to find the specified method. setAccessible(true) is called on the method if found. If the method cannot be found, null is returned. If a security restriction prevents accessing the method, that SecurityException is thrown.

Parameters:

target - The class to start searching from

name -

parameterTypes -

Returns:

Throws:

SecurityException

classExists

public static boolean classExists(String className)

Returns true if the specified class name is on the classpath. This never throws an exception - all exception conditions just return false.

Parameters:

className -

Returns:

getClassForName

public static Class<?> getClassForName(String className)

Loads a class by name with no errors, returning null if the class cannot be found.

Parameters:

className -

Returns:

getClassInstanceForName

public static Object getClassInstanceForName(String className)

Creates a new Object instance from the named class using the default no-arg constructor. No errors are thrown, null if just returned if the class does not exist, there is no no-arg constructor, so some other exception occurs.

Parameters:

className -

Returns:

findConfiguration

public static AndHowConfiguration<? extends AndHowConfiguration> findConfiguration(AndHowConfiguration<? extends AndHowConfiguration> defaultConfig)
                                                                            throws AppFatalException

Throws:

AppFatalException