com.puppycrawl.tools.checkstyle.api

Class AbstractViolationReporter

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

All Implemented Interfaces:

Configurable, Contextualizable

Direct Known Subclasses:

AbstractCheck, AbstractFileSetCheck

public abstract class AbstractViolationReporter
extends AutomaticBean

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.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	id The identifier of the reporter.
private SeverityLevel	severityLevel The severity level of any violations found.

Constructor Summary

Constructors

Constructor and Description
AbstractViolationReporter()

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.String>	getCustomMessages() Returns an unmodifiable map instance containing the custom messages for this configuration.
java.lang.String	getId() Returns the identifier of the reporter.
protected java.lang.String	getMessageBundle() Returns the message bundle name resource bundle that contains the messages used by this module.
private static java.lang.String	getMessageBundle(java.lang.String className) For unit tests, especially with a class with no package name.
java.lang.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 ast, java.lang.String key, java.lang.Object... args) Helper method to log a LocalizedMessage.
abstract void	log(int line, int col, java.lang.String key, java.lang.Object... args) Log a message that has column information.
abstract void	log(int line, java.lang.String key, java.lang.Object... args) Log a message that has no column information.
void	setId(java.lang.String id) Sets the identifier of the reporter.
void	setSeverity(java.lang.String severity) 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

Field Detail

severityLevel

private SeverityLevel severityLevel

The severity level of any violations found.

id

private java.lang.String id

The identifier of the reporter.

Constructor Detail

AbstractViolationReporter

public AbstractViolationReporter()

Method Detail

getSeverityLevel

public final SeverityLevel getSeverityLevel()

Returns the severity level of the messages generated by this module.

Returns:

the severity level

See Also:

SeverityLevel, LocalizedMessage.getSeverityLevel()

setSeverity

public final void setSeverity(java.lang.String severity)

Sets the severity level. The string should be one of the names defined in the SeverityLevel class.

Parameters:

severity - The new severity level

See Also:

SeverityLevel

getSeverity

public final java.lang.String getSeverity()

Get the severity level's name.

Returns:

the check's severity level name.

getId

public final java.lang.String getId()

Returns the identifier of the reporter. Can be null.

Returns:

the id

setId

public final void setId(java.lang.String id)

Sets the identifier of the reporter. Can be null.

Parameters:

id - the id

getCustomMessages

protected java.util.Map<java.lang.String,java.lang.String> getCustomMessages()

Returns an unmodifiable map instance containing the custom messages for this configuration.

Returns:

unmodifiable map containing custom messages

getMessageBundle

protected java.lang.String getMessageBundle()

Returns the message bundle name resource bundle 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.

Returns:

name of a resource bundle that contains the messages used by this module.

getMessageBundle

private static java.lang.String getMessageBundle(java.lang.String className)

For unit tests, especially with a class with no package name.

Parameters:

className - class name of the module.

Returns:

name of a resource bundle that contains the messages used by the module.

log

protected final void log(DetailAST ast,
                         java.lang.String key,
                         java.lang.Object... args)

Helper method to log a LocalizedMessage.

Parameters:

ast - a node to get line id column numbers associated with the message

key - key to locale message format

args - arguments to format

log

public abstract void log(int line,
                         java.lang.String key,
                         java.lang.Object... args)

Log a message that has no column information.

Parameters:

line - the line number where the error was found

key - the message that describes the error

args - the details of the message

See Also:

MessageFormat

log

public abstract void log(int line,
                         int col,
                         java.lang.String key,
                         java.lang.Object... args)

Log a message that has column information.

Parameters:

line - the line number where the error was found

col - the column number where the error was found

key - the message that describes the error

args - the details of the message

See Also:

MessageFormat