Class WarningMessage
java.lang.Object
org.codehaus.groovy.control.messages.Message
org.codehaus.groovy.control.messages.SimpleMessage
org.codehaus.groovy.control.messages.LocatedMessage
org.codehaus.groovy.control.messages.WarningMessage
A class for warning messages.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic int
static int
static int
static int
Fields inherited from class org.codehaus.groovy.control.messages.SimpleMessage
data, message, owner
-
Constructor Summary
ConstructorsConstructorDescriptionWarningMessage(int importance, String message, Object data, CSTNode context, SourceUnit owner)
Creates a new warning message.WarningMessage(int importance, String message, CSTNode context, SourceUnit owner)
Creates a new warning message. -
Method Summary
Modifier and TypeMethodDescriptionboolean
isRelevant(int importance)
Returns true if this message is as or more important than the specified importance level.static boolean
isRelevant(int actual, int limit)
Returns true if a warning would be relevant to the specified level.void
write(PrintWriter writer, Janitor janitor)
Writes the message to the specified PrintWriter.Methods inherited from class org.codehaus.groovy.control.messages.LocatedMessage
getContext
Methods inherited from class org.codehaus.groovy.control.messages.SimpleMessage
getMessage
-
Field Details
-
NONE
public static final int NONE- See Also:
- Constant Field Values
-
LIKELY_ERRORS
public static final int LIKELY_ERRORS- See Also:
- Constant Field Values
-
POSSIBLE_ERRORS
public static final int POSSIBLE_ERRORS- See Also:
- Constant Field Values
-
PARANOIA
public static final int PARANOIA- See Also:
- Constant Field Values
-
-
Constructor Details
-
WarningMessage
Creates a new warning message.- Parameters:
importance
- the warning levelmessage
- the message textcontext
- context information for locating the offending source text
-
WarningMessage
public WarningMessage(int importance, String message, Object data, CSTNode context, SourceUnit owner)Creates a new warning message.- Parameters:
importance
- the warning levelmessage
- the message textdata
- additional data needed when generating the messagecontext
- context information for locating the offending source text
-
-
Method Details
-
isRelevant
public static boolean isRelevant(int actual, int limit)Returns true if a warning would be relevant to the specified level. -
isRelevant
public boolean isRelevant(int importance)Returns true if this message is as or more important than the specified importance level. -
write
Description copied from class:Message
Writes the message to the specified PrintWriter. The supplied ProcessingUnit is the unit that holds this Message.- Overrides:
write
in classLocatedMessage
-