getMessageBundle
protected String getMessageBundle()
Returns the message bundle name resourcebundle that contains the messages
used by this module.
The default implementation expects the resource files to be named
messages.properties, messages_de.properties, etc. The file must
be placed in the same package as the module implementation.
Example: If you write com/foo/MyCoolCheck, create resource files
com/foo/messages.properties, com/foo/messages_de.properties, etc.
- name of a resource bundle that contains the messages
used by this module.
getSeverity
public final String getSeverity()
Get the severity level's name.
- the check's severity level name.
log
protected final void log(DetailAST aAST,
String aKey)
Helper method to log a LocalizedMessage.
aAST
- a node to get line and column numbers associated
with the messageaKey
- key to locale message format
log
protected final void log(DetailAST aAST,
String aKey,
Object aArg0)
Helper method to log a LocalizedMessage.
aAST
- a node to get line and column numbers associated
with the messageaKey
- key to locale message formataArg0
- an Object
value
log
protected final void log(DetailAST aAST,
String aKey,
Object aArg0,
Object aArg1)
Helper method to log a LocalizedMessage.
aAST
- a node to get line and column numbers associated
with the messageaKey
- key to locale message formataArg0
- an Object
valueaArg1
- an Object
value
log
protected final void log(int aLine,
String aKey)
Log a message.
aLine
- the line number where the error was foundaKey
- the message that describes the error
log
protected final void log(int aLineNo,
String aKey,
Object aArg0)
Helper method to log a LocalizedMessage. Column defaults to 0.
aLineNo
- line number to associate with the messageaKey
- key to locale message formataArg0
- first argument
log
protected final void log(int aLineNo,
String aKey,
Object aArg0,
Object aArg1)
Helper method to log a LocalizedMessage. Column defaults to 0.
aLineNo
- line number to associate with the messageaKey
- key to locale message formataArg0
- first argumentaArg1
- second argument
log
protected void log(int aLine,
String aKey,
aArgs[] )
Log a message that has no column information.
aLine
- the line number where the error was foundaKey
- the message that describes the error
java.text.MessageFormat
log
protected final void log(int aLineNo,
int aColNo,
String aKey)
Helper method to log a LocalizedMessage.
aLineNo
- line number to associate with the messageaColNo
- column number to associate with the messageaKey
- key to locale message format
log
protected final void log(int aLineNo,
int aColNo,
String aKey,
Object aArg0)
Helper method to log a LocalizedMessage.
aLineNo
- line number to associate with the messageaColNo
- column number to associate with the messageaKey
- key to locale message formataArg0
- an Object
value
log
protected final void log(int aLineNo,
int aColNo,
String aKey,
Object aArg0,
Object aArg1)
Helper method to log a LocalizedMessage.
aLineNo
- line number to associate with the messageaColNo
- column number to associate with the messageaKey
- key to locale message formataArg0
- an Object
valueaArg1
- an Object
value
log
protected void log(int aLine,
int aCol,
String aKey,
Object[] aArgs)
Log a message that has column information.
aLine
- the line number where the error was foundaCol
- the column number where the error was foundaKey
- the message that describes the erroraArgs
- the details of the message
java.text.MessageFormat
setSeverity
public final void setSeverity(String aSeverity)
Sets the severity level. The string should be one of the names
defined in the SeverityLevel
class.
aSeverity
- The new severity level
SeverityLevel