org.yarnandtail.andhow.compile

Class CompileUnit

java.lang.Object

org.yarnandtail.andhow.compile.CompileUnit

public class CompileUnit
extends Object

Incrementally built metadata about a Type (compile-time representation of a class) and its AndHow Properties (if any) as it is compiled. One instance of a CompileUnit corresponds to a single top level class, that is, a class or interface that is not an inner class and for which the only logical parent is its package. Inner classes and interfaces are represented as the 'inner path' - the heirarchical list of nested inner classes from the outer to the innermost one. The state of the inner path is recorded each time addProperty() is called, so that each Property can be registered with the appropriate inner path, which will then make up its canonical name. This class is used by doing a depth first scan of a Type. As each Type is found it is pushType'ed into the CompileUnit. Types are popType()'ed out when the scan leaves a type. Within a type, variables are scanned. If a variable with the type AndHow Property is discovered and the assignment is from a newly constructed Property (not just a reference), addProperty() is called and the metadata about the inner path and variable name are recorded here. This class is stateful and is not thread safe.

Author:

ericeverman

Constructor Summary

Constructors

Constructor and Description
CompileUnit(String classCanonName) Construct a new CompileUnit, which always is for a specific top level class.

Method Summary

Modifier and Type	Method and Description
boolean	addProperty(SimpleVariable variableElement) Register an AndHow Property declaration in the current scope - either directly in the the top level class or the recorded path to an inner class.
boolean	addProperty(String name, boolean _static, boolean _final) Register an AndHow Property declaration in the current scope - either directly in the the top level class or the recorded path to an inner class.
void	addPropertyError(String propName, String msg)
List<String>	getErrors() The list of Property errors, either directly added or created indirectly by adding properties that had invalid modifiers.
List<SimpleType>	getInnerPath() Return the state of inner class nesting from the outermost to the innermost.
List<String>	getInnerPathNames() Return the inner class names, in order from the outermost to the innermost.
PropertyRegistrationList	getRegistrations() The list of Properties in the CompileUnit, along with all the needed metadata to register them.
String	getRootCanonicalName() The fully qualified name of the top level class this CompileUnit is for.
String	getRootPackageName() Get just the package of the root class.
String	getRootSimpleName() Get just the simple name of the root class.
boolean	hasErrors() Returns true if the getErrors() list would be non-empty.
boolean	hasRegistrations() Returns true if getRegistrations() would return a non-empty list.
boolean	isInitClass()
boolean	istestInitClass()
SimpleType	popType()
void	pushType(SimpleType simpleName)
void	pushType(String name, boolean _static)
void	setInitClass(boolean initClass)
void	setTestInitClass(boolean testInitClass)

Methods inherited from class java.lang.Object

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

Constructor Detail

CompileUnit

public CompileUnit(String classCanonName)

Construct a new CompileUnit, which always is for a specific top level class. A top level class is a non-inner class.

Parameters:

classCanonName - The fully qualified name of a top level class.

Method Detail

isInitClass

public boolean isInitClass()

setInitClass

public void setInitClass(boolean initClass)

istestInitClass

public boolean istestInitClass()

setTestInitClass

public void setTestInitClass(boolean testInitClass)

pushType

public void pushType(SimpleType simpleName)

pushType

public void pushType(String name,
                     boolean _static)

popType

public SimpleType popType()

addProperty

public boolean addProperty(SimpleVariable variableElement)

Register an AndHow Property declaration in the current scope - either directly in the the top level class or the recorded path to an inner class. If modifiers are invalid, an error will be recorded rather than a Property.

Parameters:

variableElement - A SimpleType representing a variable to which an AndHow property is constructed and assigned to.

Returns:

True if the property could be added, false if an error was recorded instead.

addProperty

public boolean addProperty(String name,
                           boolean _static,
                           boolean _final)

Register an AndHow Property declaration in the current scope - either directly in the the top level class or the recorded path to an inner class. If modifiers are invalid, an error will be recorded rather than a Property.

Parameters:

name - The name of the variable the Property is assigned to.

_static - Does the variable has the static modifier?

_final - Is the variable declared as static?

Returns:

True if the property could be added, false if an error was recorded instead.

getInnerPath

public List<SimpleType> getInnerPath()

Return the state of inner class nesting from the outermost to the innermost. If the current state is at the root of the top level class, an empty list is returned.

Returns:

See Also:

for just the names of the nested inner classes.

getInnerPathNames

public List<String> getInnerPathNames()

Return the inner class names, in order from the outermost to the innermost. If the current state is at the root of the top level class, an empty list is returned.

Returns:

addPropertyError

public void addPropertyError(String propName,
                             String msg)

getRootCanonicalName

public String getRootCanonicalName()

The fully qualified name of the top level class this CompileUnit is for.

Returns:

getRootSimpleName

public String getRootSimpleName()

Get just the simple name of the root class.

Returns:

getRootPackageName

public String getRootPackageName()

Get just the package of the root class.

Returns:

null if the root class is in the default package.

getRegistrations

public PropertyRegistrationList getRegistrations()

The list of Properties in the CompileUnit, along with all the needed metadata to register them.

Returns:

getErrors

public List<String> getErrors()

The list of Property errors, either directly added or created indirectly by adding properties that had invalid modifiers.

Returns:

hasErrors

public boolean hasErrors()

Returns true if the getErrors() list would be non-empty.

Returns:

hasRegistrations

public boolean hasRegistrations()

Returns true if getRegistrations() would return a non-empty list.

Returns: