org.yarnandtail.andhow.util

Class NameUtil

java.lang.Object

org.yarnandtail.andhow.util.NameUtil

public class NameUtil
extends Object

Author:

ericeverman

Constructor Summary

Constructors

Constructor and Description
NameUtil()

Method Summary

Modifier and Type	Method and Description
static String	getAndHowName(Class<?> group) The AndHow style name for a class.
static String	getAndHowName(Class<?> group, Property<?> property) Gets the true canonical name for a Property in the group.
static String	getAndHowName(String classCanonName, String[] innerPath) The AndHow canonical name of the direct parent of the AndHow Property.
static String	getAndHowName(String classCanonName, String propName, List<String> innerPath) The AndHow canonical name of the property, which is the root canonical name plus the elements of the inner path and the property name, all separated by dots.
static String	getAndHowName(String classCanonName, String propName, String... innerPath) The AndHow canonical name of the property, which is the root canonical name plus the elements of the inner path and the property name, all separated by dots.
static String	getJavaName(Class<?> group) The Java style name for a class, usable with Class.forName().
static String	getJavaName(String classCanonName, List<String> innerPath) The Java canonical name of the direct parent of the AndHow Property.
static String	getJavaName(String classCanonName, String[] innerPath) The Java canonical name of the direct parent of the AndHow Property.

Methods inherited from class java.lang.Object

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

Constructor Detail

NameUtil

public NameUtil()

Method Detail

getAndHowName

public static String getAndHowName(String classCanonName,
                                   String propName,
                                   List<String> innerPath)

The AndHow canonical name of the property, which is the root canonical name plus the elements of the inner path and the property name, all separated by dots. Note: This is NOT THE SAME as getJavaName() plus the property name. Java uses dollar signs to separate inner classes instead of dots.

Parameters:

classCanonName - The fully qualified name of the top level class

propName - The simple name of the property (the name of the variable it is assigned to at construction).

innerPath - Any inner classes containing the property within the top level class, in order from outer to inner.

Returns:

getAndHowName

public static String getAndHowName(String classCanonName,
                                   String propName,
                                   String... innerPath)

The AndHow canonical name of the property, which is the root canonical name plus the elements of the inner path and the property name, all separated by dots. Note: This is NOT THE SAME as getJavaName() plus the property name. Java uses dollar signs to separate inner classes instead of dots.

Parameters:

classCanonName - The fully qualified name of the top level class

propName - The simple name of the property (the name of the variable it is assigned to at construction).

innerPath - Any inner classes containing the property within the top level class, in order from outer to inner.

Returns:

getJavaName

public static String getJavaName(String classCanonName,
                                 String[] innerPath)

The Java canonical name of the direct parent of the AndHow Property. This may be the canonical name of the root class if there is no inner path, or it may include an inner path. Java canonical names which include inner classes use the dollar sign as a delimiter once the path goes 'internal' and that syntax is required if constructing the class via Class.forName

Example path: com.fastco.ClassName$InnerClass

Parameters:

classCanonName -

innerPath -

Returns:

getJavaName

public static String getJavaName(String classCanonName,
                                 List<String> innerPath)

The Java canonical name of the direct parent of the AndHow Property. This may be the canonical name of the root class if there is no inner path, or it may include an inner path. Java canonical names which include inner classes use the dollar sign as a delimiter once the path goes 'internal' and that syntax is required if constructing the class via Class.forName

Example path: com.fastco.ClassName$InnerClass

Parameters:

classCanonName -

innerPath -

Returns:

getAndHowName

public static String getAndHowName(String classCanonName,
                                   String[] innerPath)

The AndHow canonical name of the direct parent of the AndHow Property. This may be the canonical name of the root class if there is no inner path, or it may include an inner path. Unlike Java canonical names, AndHow canonical paths use dots to separate all steps in the path, including the inner class (Java canonical paths use the dollar sign as a delimiter for inner classes).

Example path: com.fastco.ClassName.InnerClass

Parameters:

classCanonName -

innerPath -

Returns:

getAndHowName

public static String getAndHowName(Class<?> group)

The AndHow style name for a class. This is an all dot separated name, including separation for inner classes. This method doesn't add much utility, but clearly documents the different name styles.

Parameters:

group -

Returns:

getJavaName

public static String getJavaName(Class<?> group)

The Java style name for a class, usable with Class.forName(). This is a dot separated name up to inner classes, which are separated by dollar signs, which is the Java convention. This method doesn't add much utility, but clearly documents the different name styles.

Parameters:

group -

Returns:

getAndHowName

public static String getAndHowName(Class<?> 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