com.puppycrawl.tools.checkstyle.filters
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.
See Also: FileContentsHolder
Nested Class Summary | |
---|---|
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 | |
---|---|
SuppressionCommentFilter()
Constructs a SuppressionCommentFilter.
|
Method Summary | |
---|---|
boolean | accept(AuditEvent aEvent) {@inheritDoc} |
FileContents | getFileContents() |
void | setCheckC(boolean aCheckC)
Set whether to look in C comments. |
void | setCheckCPP(boolean aCheckCPP)
Set whether to look in C++ comments. |
void | setCheckFormat(String aFormat)
Set the format for a check. |
void | setFileContents(FileContents aFileContents)
Set the FileContents for this filter. |
void | setMessageFormat(String aFormat)
Set the format for a message. |
void | setOffCommentFormat(String aFormat)
Set the format for a comment that turns off reporting. |
void | setOnCommentFormat(String aFormat)
Set the format for a comment that turns on reporting. |
Returns: the FileContents for this filter.
Parameters: aCheckC true
if C comments are checked.
Parameters: aCheckCPP true
if C++ comments are checked.
Parameters: aFormat a String
value
Throws: ConversionException unable to parse aFormat
Parameters: aFileContents the FileContents for this filter.
Parameters: aFormat a String
value
Throws: ConversionException unable to parse aFormat
Parameters: aFormat a String
value.
Throws: ConversionException unable to parse aFormat.
Parameters: aFormat a String
value
Throws: ConversionException unable to parse aFormat