org.yarnandtail.andhow.compile

Class CompileProblem

java.lang.Object

org.yarnandtail.andhow.compile.CompileProblem

public abstract class CompileProblem
extends Object

Implementation represent specific problems with AndHow Property usage or initiation, discovered during compilation.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Logical equals implementation based on equality of fields.
abstract String	getFullMessage() The complete message that will be logged during compilation.
String	getGroupName() Full name of the class containing the Property.
String	getPropertyName() The declared name of the Property that has the problem.
boolean	isPropertyProblem() If true, the problem is related to a specific Property.

Methods inherited from class java.lang.Object

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

Method Detail

getGroupName

public String getGroupName()

Full name of the class containing the Property. In the case of an inner class, this should be the complete name including that inner class.

Returns:

May be null if this is not a property related problem.

getPropertyName

public String getPropertyName()

The declared name of the Property that has the problem.

Returns:

May be null if this is not a property related problem.

isPropertyProblem

public boolean isPropertyProblem()

If true, the problem is related to a specific Property.

Returns:

equals

public boolean equals(Object o)

Logical equals implementation based on equality of fields. This is only used for comparisons during testing.

Overrides:

equals in class Object

Parameters:

o - Compared to me.

Returns:

True if logically equal.

getFullMessage

public abstract String getFullMessage()

The complete message that will be logged during compilation. Intended to be user readable w/ enough info for the user to understand and find the issue.

Returns:

A String explanation of the problem.