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.
FileContentsHolder
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 and Description |
---|
SuppressionCommentFilter()
Constructs a SuppressionCommentFilter.
|
Modifier and Type | Method and Description |
---|---|
boolean |
accept(AuditEvent aEvent)
Determines whether or not a filtered AuditEvent is accepted.
|
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.
|
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public SuppressionCommentFilter()
public void setOffCommentFormat(String aFormat) throws org.apache.commons.beanutils.ConversionException
aFormat
- a String
value.org.apache.commons.beanutils.ConversionException
- unable to parse aFormat.public void setOnCommentFormat(String aFormat) throws org.apache.commons.beanutils.ConversionException
aFormat
- a String
valueorg.apache.commons.beanutils.ConversionException
- unable to parse aFormatpublic FileContents getFileContents()
public void setFileContents(FileContents aFileContents)
aFileContents
- the FileContents for this filter.public void setCheckFormat(String aFormat) throws org.apache.commons.beanutils.ConversionException
aFormat
- a String
valueorg.apache.commons.beanutils.ConversionException
- unable to parse aFormatpublic void setMessageFormat(String aFormat) throws org.apache.commons.beanutils.ConversionException
aFormat
- a String
valueorg.apache.commons.beanutils.ConversionException
- unable to parse aFormatpublic void setCheckCPP(boolean aCheckCPP)
aCheckCPP
- true
if C++ comments are checked.public void setCheckC(boolean aCheckC)
aCheckC
- true
if C comments are checked.public boolean accept(AuditEvent aEvent)
Copyright © 2001–2019. All rights reserved.