|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
public abstract class AbstractViolationReporter
Serves as an abstract base class for all modules that report inspection
findings. Such modules have a Severity level which is used for the
localized messages that are created by the module.
| Constructor Summary | |
|---|---|
AbstractViolationReporter()
|
|
| Method Summary | |
|---|---|
protected Map<String,String> |
getCustomMessages()
Returns an unmodifiable map instance containing the custom messages for this configuration. |
String |
getId()
Returns the identifier of the reporter. |
protected String |
getMessageBundle()
Returns the message bundle name resourcebundle that contains the messages used by this module. |
String |
getSeverity()
Get the severity level's name. |
SeverityLevel |
getSeverityLevel()
Returns the severity level of the messages generated by this module. |
protected void |
log(DetailAST aAST,
String aKey,
Object... aArgs)
Helper method to log a LocalizedMessage. |
abstract void |
log(int aLine,
int aCol,
String aKey,
Object... aArgs)
Log a message that has column information. |
abstract void |
log(int aLine,
String aKey,
Object... aArgs)
Log a message that has no column information. |
void |
setId(String aId)
Sets the identifier of the reporter. |
void |
setSeverity(String aSeverity)
Sets the severity level. |
| Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean |
|---|
configure, contextualize, finishLocalSetup, getConfiguration, setupChild |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public AbstractViolationReporter()
| Method Detail |
|---|
public final SeverityLevel getSeverityLevel()
SeverityLevel,
LocalizedMessage.getSeverityLevel()public final void setSeverity(String aSeverity)
SeverityLevel class.
aSeverity - The new severity levelSeverityLevelpublic final String getSeverity()
public final String getId()
public final void setId(String aId)
aId - the id
protected final void log(DetailAST aAST,
String aKey,
Object... aArgs)
aAST - a node to get line and column numbers associated
with the messageaKey - key to locale message formataArgs - arguments to formatprotected String getMessageBundle()
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.
protected Map<String,String> getCustomMessages()
public abstract void log(int aLine,
String aKey,
Object... aArgs)
aLine - the line number where the error was foundaKey - the message that describes the erroraArgs - the details of the messageMessageFormat
public abstract void log(int aLine,
int aCol,
String aKey,
Object... aArgs)
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 messageMessageFormat
|
Back to the Checkstyle Home Page | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||