org.yarnandtail.andhow.service

Class PropertyRegistration

java.lang.Object

org.yarnandtail.andhow.service.PropertyRegistration

All Implemented Interfaces:

Comparable<PropertyRegistration>

public class PropertyRegistration
extends Object
implements Comparable<PropertyRegistration>

Registration for a single Property, which registers a single Property with AndHow during startup at run time.

Property registration background

At compile time, the AndHowCompileProcessor (an annotation Processor), reads user classes and generates a PropertyRegistrar instance for each root class (non-inner class) that contains an AndHow Property. Matching service files are also generated in the "META-INF/services/" directory so the PropertyRegistrar instances can be discovered through the java.util.ServiceLoader mechanism.

At run time, the PropertyRegistrarLoader discovers all PropertyRegistrar instances. Each PropertyRegistrar creates a PropertyRegistrationList instance with a PropertyRegistration for each Property present in the jar.

Author:

ericeverman

Method Summary

Modifier and Type	Method and Description
int	compareInnerPathTo(PropertyRegistration o) Equivalent to compareTo for just the inner path class and its fully qualified path.
int	compareRootTo(PropertyRegistration o) Equivalent to compareTo for just the root class and its fully qualified path.
int	compareTo(PropertyRegistration o) Comparison that results in sorting from root properties to the most nested, incrementally by each inner path step.
String	getCanonicalParentName() The AndHow canonical name of the direct parent of the AndHow Property.
String	getCanonicalPropertyName() 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.
String	getCanonicalRootName() The canonical propName of the root class, which is the top level class, typically one per Java source file (unless someone has stuffed multiple top level classes into a single file, which is technically allowed).
String[]	getInnerPath() The names of the nested inner classes/interfaces containing the named property for this registration.
int	getInnerPathLength() The number of nested inner classes / interfaces from the root class to the inner class containing the AndHow Property.
String	getJavaCanonicalParentName() The Java canonical name of the direct parent of the AndHow Property.
String	getPropertyName() The name of the AndHow property, which is the name of the variable it is assigned to where it is constructed.

Methods inherited from class java.lang.Object

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

Method Detail

getCanonicalRootName

public String getCanonicalRootName()

The canonical propName of the root class, which is the top level class, typically one per Java source file (unless someone has stuffed multiple top level classes into a single file, which is technically allowed). An inner class or inner interface would be represented by the inner path, not by the root canonical propName.

Returns:

The Java canonical name of the root class containing the Property declaration, or in the case of a Property declared in an inner class, the name of the class containing the inner class.

getPropertyName

public String getPropertyName()

The name of the AndHow property, which is the name of the variable it is assigned to where it is constructed.

Returns:

The declared name of the variable referencing the Property declaration.

getInnerPath

public String[] getInnerPath()

The names of the nested inner classes/interfaces containing the named property for this registration.

If a class Foo contained an inner class Bar, which contained an inner class Baz, which contained an AndHow property declaration assigned to a variable named Boo:

• getCanonicalRootName would return Foo's canonical path
• getInnerPath would return the array of "Bar", "Baz"
• getPropertyName would return "Boo"

Returns:

The inner path array, in order from top level to leaf level. It may be null if the Property is declared directly in a root class.

getInnerPathLength

public int getInnerPathLength()

The number of nested inner classes / interfaces from the root class to the inner class containing the AndHow Property.

Returns:

The number of steps in the inner path. A Property declared directly in a root class with have a length of zero.

getCanonicalPropertyName

public String getCanonicalPropertyName()

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.

Returns:

The full complete canonical name for the Property, which uses dots to separate each step.

getJavaCanonicalParentName

public String getJavaCanonicalParentName()

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

For the inner class InnerClass of class com.fastco.ClassName, the canonical names would be:

• Java canonical name: com.fastco.ClassName$InnerClass
• AndHow canonical name: com.fastco.ClassName.InnerClass

Returns:

The Java canonical name of the class or inner class containing the Property.

getCanonicalParentName

public String getCanonicalParentName()

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. The AndHow canonical name differs from the Java canonical name: AndHow uses dots to separate all 'steps' in the classpath while Java uses the dollar sign as a delimiter once the path goes 'internal'. The Java canonical name syntax is required if constructing the class via Class.forName

For the inner class InnerClass of class com.fastco.ClassName, the canonical names would be:

• Java canonical name: com.fastco.ClassName$InnerClass
• AndHow canonical name: com.fastco.ClassName.InnerClass

Returns:

The AndHow canonical name of the class or inner class containing the Property.

compareRootTo

public int compareRootTo(PropertyRegistration o)

Equivalent to compareTo for just the root class and its fully qualified path.

Parameters:

o - The PropertyRegistration to compare to.

Returns:

An int used for sorting that is based only on the root class.

compareInnerPathTo

public int compareInnerPathTo(PropertyRegistration o)

Equivalent to compareTo for just the inner path class and its fully qualified path.

Parameters:

o - The PropertyRegistration to compare to.

Returns:

int for sorting based only on the inner path.

compareTo

public int compareTo(PropertyRegistration o)

Comparison that results in sorting from root properties to the most nested, incrementally by each inner path step.

Specified by:

compareTo in interface Comparable<PropertyRegistration>

Parameters:

o - The PropertyRegistration to compare to.

Returns:

An int used for sorting that provides 'correct' sorting.