com.puppycrawl.tools.checkstyle.filters

Class SuppressionCommentFilter

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
classSuppressionCommentFilter.Tag
A Tag holds a suppression comment and its location, and determines whether the supression turns checkstyle reporting on or off.
Constructor Summary
SuppressionCommentFilter()
Constructs a SuppressionCommentFilter.
Method Summary
booleanaccept(AuditEvent aEvent)
{@inheritDoc}
FileContentsgetFileContents()
voidsetCheckC(boolean aCheckC)
Set whether to look in C comments.
voidsetCheckCPP(boolean aCheckCPP)
Set whether to look in C++ comments.
voidsetCheckFormat(String aFormat)
Set the format for a check.
voidsetFileContents(FileContents aFileContents)
Set the FileContents for this filter.
voidsetMessageFormat(String aFormat)
Set the format for a message.
voidsetOffCommentFormat(String aFormat)
Set the format for a comment that turns off reporting.
voidsetOnCommentFormat(String aFormat)
Set the format for a comment that turns on reporting.

Constructor Detail

SuppressionCommentFilter

public SuppressionCommentFilter()
Constructs a SuppressionCommentFilter. Initializes comment on, comment off, and check formats to defaults.

Method Detail

accept

public boolean accept(AuditEvent aEvent)
{@inheritDoc}

getFileContents

public FileContents getFileContents()

Returns: the FileContents for this filter.

setCheckC

public void setCheckC(boolean aCheckC)
Set whether to look in C comments.

Parameters: aCheckC true if C comments are checked.

setCheckCPP

public void setCheckCPP(boolean aCheckCPP)
Set whether to look in C++ comments.

Parameters: aCheckCPP true if C++ comments are checked.

setCheckFormat

public void setCheckFormat(String aFormat)
Set the format for a check.

Parameters: aFormat a String value

Throws: ConversionException unable to parse aFormat

setFileContents

public void setFileContents(FileContents aFileContents)
Set the FileContents for this filter.

Parameters: aFileContents the FileContents for this filter.

setMessageFormat

public void setMessageFormat(String aFormat)
Set the format for a message.

Parameters: aFormat a String value

Throws: ConversionException unable to parse aFormat

setOffCommentFormat

public void setOffCommentFormat(String aFormat)
Set the format for a comment that turns off reporting.

Parameters: aFormat a String value.

Throws: ConversionException unable to parse aFormat.

setOnCommentFormat

public void setOnCommentFormat(String aFormat)
Set the format for a comment that turns on reporting.

Parameters: aFormat a String value

Throws: ConversionException unable to parse aFormat