Class SuppressWithNearbyCommentFilter
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.api.AutomaticBean
-
- com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
-
- All Implemented Interfaces:
Configurable
,Contextualizable
,Filter
public class SuppressWithNearbyCommentFilter extends AutomaticBean implements Filter
A filter that uses nearby comments to suppress audit events.
This check is philosophically similar to
SuppressionCommentFilter
. UnlikeSuppressionCommentFilter
, this filter does not require pairs of comments. This check may be used to suppress warnings in the current line:offendingLine(for, whatever, reason); // SUPPRESS ParameterNumberCheck
or it may be configured to span multiple lines, either forward:// PERMIT MultipleVariableDeclarations NEXT 3 LINES double x1 = 1.0, y1 = 0.0, z1 = 0.0; double x2 = 0.0, y2 = 1.0, z2 = 0.0; double x3 = 0.0, y3 = 0.0, z3 = 1.0;
or reverse:try { thirdPartyLibrary.method(); } catch (RuntimeException ex) { // ALLOW ILLEGAL CATCH BECAUSE third party API wraps everything // in RuntimeExceptions. ... }
See
SuppressionCommentFilter
for usage notes.- Author:
- Mick Killianey
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SuppressWithNearbyCommentFilter.Tag
A Tag holds a suppression comment and its location.
-
Constructor Summary
Constructors Constructor Description SuppressWithNearbyCommentFilter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
accept(AuditEvent event)
Determines whether or not a filtered AuditEvent is accepted.FileContents
getFileContents()
Returns FileContents for this filter.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
setCommentFormat(Pattern pattern)
Set the format for a comment that turns off reporting.void
setFileContents(FileContents fileContents)
Set the FileContents for this filter.void
setInfluenceFormat(String format)
Set the format for the influence of this check.void
setMessageFormat(String format)
Set the format for a message.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
-
-
-
-
Constructor Detail
-
SuppressWithNearbyCommentFilter
public SuppressWithNearbyCommentFilter()
-
-
Method Detail
-
setCommentFormat
public final void setCommentFormat(Pattern pattern)
Set the format for a comment that turns off reporting.- Parameters:
pattern
- a pattern.
-
getFileContents
public FileContents getFileContents()
Returns FileContents for this filter.- 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 final void setCheckFormat(String format)
Set the format for a check.- Parameters:
format
- aString
value
-
setMessageFormat
public void setMessageFormat(String format)
Set the format for a message.- Parameters:
format
- aString
value
-
setInfluenceFormat
public final void setInfluenceFormat(String format)
Set the format for the influence of this check.- Parameters:
format
- aString
value
-
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)
Description copied from interface:Filter
Determines whether or not a filtered AuditEvent is accepted.
-
-