com.puppycrawl.tools.checkstyle.filters

Class SuppressionCommentFilter

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter

All Implemented Interfaces:

Configurable, Contextualizable, Filter

public class SuppressionCommentFilter
extends AutomaticBean
implements Filter

A filter that uses comments to suppress audit events.

Rationale: Sometimes there are legitimate reasons for violating a check. When this is a matter of the code in question and not personal preference, the best place to override the policy is in the code itself. Semi-structured comments can be associated with the check. This is sometimes superior to a separate suppressions file, which must be kept up-to-date as the source file is edited.

Usage: This check only works in conjunction with the FileContentsHolder module since that module makes the suppression comments in the .java files available sub rosa.

Author:

Mike McMahon, Rick Giles

See Also:

FileContentsHolder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SuppressionCommentFilter.Tag A Tag holds a suppression comment and its location, and determines whether the supression turns checkstyle reporting on or off.

Constructor Summary

Constructors

Constructor and Description
SuppressionCommentFilter() Constructs a SuppressionCoontFilter.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(AuditEvent event) Determines whether or not a filtered AuditEvent is accepted.
FileContents	getFileContents()
void	setCheckC(boolean checkC) Set whether to look in C comments.
void	setCheckCPP(boolean checkCPP) Set whether to look in C++ comments.
void	setCheckFormat(String format) Set the format for a check.
void	setFileContents(FileContents fileContents) Set the FileContents for this filter.
void	setMessageFormat(String format) Set the format for a message.
void	setOffCommentFormat(String format) Set the format for a comment that turns off reporting.
void	setOnCommentFormat(String format) Set the format for a comment that turns on reporting.

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

SuppressionCommentFilter

public SuppressionCommentFilter()

Constructs a SuppressionCoontFilter. Initializes comment on, comment off, and check formats to defaults.

Method Detail

setOffCommentFormat

public void setOffCommentFormat(String format)
                         throws org.apache.commons.beanutils.ConversionException

Set the format for a comment that turns off reporting.

Parameters:

format - a String value.

Throws:

org.apache.commons.beanutils.ConversionException - unable to parse format.

setOnCommentFormat

public void setOnCommentFormat(String format)
                        throws org.apache.commons.beanutils.ConversionException

Set the format for a comment that turns on reporting.

Parameters:

format - a String value

Throws:

org.apache.commons.beanutils.ConversionException - unable to parse format

getFileContents

public FileContents getFileContents()

Returns:

the FileContents for this filter.

setFileContents

public void setFileContents(FileContents fileContents)

Set the FileContents for this filter.

Parameters:

fileContents - the FileContents for this filter.

setCheckFormat

public void setCheckFormat(String format)
                    throws org.apache.commons.beanutils.ConversionException

Set the format for a check.

Parameters:

format - a String value

Throws:

org.apache.commons.beanutils.ConversionException - unable to parse format

setMessageFormat

public void setMessageFormat(String format)
                      throws org.apache.commons.beanutils.ConversionException

Set the format for a message.

Parameters:

format - a String value

Throws:

org.apache.commons.beanutils.ConversionException - unable to parse format

setCheckCPP

public void setCheckCPP(boolean checkCPP)

Set whether to look in C++ comments.

Parameters:

checkCPP - true if C++ comments are checked.

setCheckC

public void setCheckC(boolean checkC)

Set whether to look in C comments.

Parameters:

checkC - true if C comments are checked.

accept

public boolean accept(AuditEvent event)

Determines whether or not a filtered AuditEvent is accepted.

Specified by:

accept in interface Filter

Parameters:

event - the AuditEvent to filter.

Returns:

true if the event is accepted.