SuppressWithNearbyCommentFilter (checkstyle 8.35-SNAPSHOT API)

java.lang.Object
- com.puppycrawl.tools.checkstyle.api.AutomaticBean
- - com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter

All Implemented Interfaces:: Configurable, Contextualizable, TreeWalkerFilter

public class SuppressWithNearbyCommentFilter
extends AutomaticBean
implements TreeWalkerFilter

Filter SuppressWithNearbyCommentFilter uses nearby comments to suppress audit events.

Rationale: Same as SuppressionCommentFilter. Whereas the SuppressionCommentFilter uses matched pairs of filters to turn on/off comment matching, SuppressWithNearbyCommentFilter uses single comments. This requires fewer lines to mark a region, and may be aesthetically preferable in some contexts.

Attention: This filter may only be specified within the TreeWalker module (<module name="TreeWalker"/>) and only applies to checks which are also defined within this module. To filter non-TreeWalker checks like RegexpSingleline, a SuppressWithPlainTextCommentFilter or similar filter must be used.

SuppressWithNearbyCommentFilter can suppress Checks that have Treewalker as parent module.

Property commentFormat - Specify comment pattern to trigger filter to begin suppression. Type is java.util.regex.Pattern. Default value is "SUPPRESS CHECKSTYLE (\w+)".
Property checkFormat - Specify check pattern to suppress. Type is java.lang.String. Default value is ".*".
Property messageFormat - Define message pattern to suppress. Type is java.lang.String. Default value is null.
Property idFormat - Specify check ID pattern to suppress. Type is java.lang.String. Default value is null.
Property influenceFormat - Specify negative/zero/positive value that defines the number of lines preceding/at/following the suppression comment. Type is java.lang.String. Default value is "0".
Property checkCPP - Control whether to check C++ style comments (//). Type is boolean. Default value is true.
Property checkC - Control whether to check C style comments (/* ... */). Type is boolean. Default value is true.

To configure a filter to suppress audit events for check on any line with a comment SUPPRESS CHECKSTYLE check:

 <module name="SuppressWithNearbyCommentFilter"/>

 private int [] array; // SUPPRESS CHECKSTYLE

To configure a filter to suppress all audit events on any line containing the comment CHECKSTYLE IGNORE THIS LINE:

 <module name="SuppressWithNearbyCommentFilter">
   <property name="commentFormat" value="CHECKSTYLE IGNORE THIS LINE"/>
   <property name="checkFormat" value=".*"/>
   <property name="influenceFormat" value="0"/>
 </module>

 public static final int lowerCaseConstant; // CHECKSTYLE IGNORE THIS LINE

To configure a filter so that // OK to catch (Throwable|Exception|RuntimeException) here permits the current and previous line to avoid generating an IllegalCatch audit event:

 <module name="SuppressWithNearbyCommentFilter">
   <property name="commentFormat" value="OK to catch (\w+) here"/>
   <property name="checkFormat" value="IllegalCatchCheck"/>
   <property name="messageFormat" value="$1"/>
   <property name="influenceFormat" value="-1"/>
 </module>

 . . .
 catch (RuntimeException re) {
 // OK to catch RuntimeException here
 }
 catch (Throwable th) { ... }
 . . .

To configure a filter so that CHECKSTYLE IGNORE check FOR NEXT var LINES avoids triggering any audits for the given check for the current line and the next var lines (for a total of var+1 lines):

 <module name="SuppressWithNearbyCommentFilter">
   <property name="commentFormat"
       value="CHECKSTYLE IGNORE (\w+) FOR NEXT (\d+) LINES"/>
   <property name="checkFormat" value="$1"/>
   <property name="influenceFormat" value="$2"/>
 </module>

 static final int lowerCaseConstant; // CHECKSTYLE IGNORE ConstantNameCheck FOR NEXT 3 LINES
 static final int lowerCaseConstant1;
 static final int lowerCaseConstant2;
 static final int lowerCaseConstant3;
 static final int lowerCaseConstant4; // will warn here

To configure a filter to avoid any audits on code like:

 <module name="SuppressWithNearbyCommentFilter">
   <property name="commentFormat"
     value="ALLOW (\\w+) ON PREVIOUS LINE"/>
   <property name="checkFormat" value="$1"/>
   <property name="influenceFormat" value="-1"/>
 </module>

 private int D2;
 // ALLOW MemberName ON PREVIOUS LINE
 . . .

To configure a filter to allow suppress one or more Checks (separated by "|") and demand comment no less than 14 symbols:

 <module name="SuppressWithNearbyCommentFilter">
   <property name="commentFormat"
     value="@cs\.suppress \[(\w+(\|\w+)*)\] \w[-\.'`,:;\w ]{14,}"/>
   <property name="checkFormat" value="$1"/>
   <property name="influenceFormat" value="1"/>
 </module>

 public static final int [] array; // @cs.suppress [ConstantName|NoWhitespaceAfter] A comment here

It is possible to specify an ID of checks, so that it can be leveraged by the SuppressWithNearbyCommentFilter to skip validations. The following examples show how to skip validations near code that has comment like // @cs-: <ID/> (reason), where ID is the ID of checks you want to suppress.

Examples of Checkstyle checks configuration:

 <module name="RegexpSinglelineJava">
   <property name="id" value="ignore"/>
   <property name="format" value="^.*@Ignore\s*$"/>
   <property name="message" value="@Ignore should have a reason."/>
 </module>

 <module name="RegexpSinglelineJava">
   <property name="id" value="systemout"/>
   <property name="format" value="^.*System\.(out|err).*$"/>
   <property name="message" value="Don't use System.out/err, use SLF4J instead."/>
 </module>

Example of SuppressWithNearbyCommentFilter configuration (idFormat which is set to '$1' points that ID of the checks is in the first group of commentFormat regular expressions):

 <module name="SuppressWithNearbyCommentFilter">
   <property name="commentFormat" value="@cs-: (\w+) \(.*\)"/>
   <property name="idFormat" value="$1"/>
   <property name="influenceFormat" value="0"/>
 </module>

 @Ignore // @cs-: ignore (test has not been implemented yet)
 @Test
 public void testMethod() { }

 public static void foo() {
   System.out.println("Debug info."); // @cs-: systemout (should not fail RegexpSinglelineJava)
 }

Example of how to configure the check to suppress more than one checks. The influence format format is specified in the second regexp group.

 <module name="SuppressWithNearbyCommentFilter">
   <property name="commentFormat" value="@cs-\: ([\w\|]+) influence (\d+)"/>
   <property name="checkFormat" value="$1"/>
   <property name="influenceFormat" value="$2"/>
 </module>

 // @cs-: ClassDataAbstractionCoupling influence 2
 // @cs-: MagicNumber influence 4
 @Service // no violations from ClassDataAbstractionCoupling here
 @Transactional
 public class UserService {
   private int value = 10022; // no violations from MagicNumber here
 }

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Since:: 5.0

Nested Class Summary
- Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
  AutomaticBean.OutputStreamOptions

Constructor Summary

Constructors
Constructor and Description

SuppressWithNearbyCommentFilter()

Constructors
Constructor and Description
`SuppressWithNearbyCommentFilter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`accept(TreeWalkerAuditEvent event)` Determines whether or not a filtered `TreeWalkerAuditEvent` is accepted.
`protected void`	`finishLocalSetup()` Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.
`void`	`setCheckC(boolean checkC)` Setter to control whether to check C style comments (`/* ... */`).
`void`	`setCheckCPP(boolean checkCpp)` Setter to control whether to check C++ style comments (`//`).
`void`	`setCheckFormat(String format)` Setter to specify check pattern to suppress.
`void`	`setCommentFormat(Pattern pattern)` Setter to specify comment pattern to trigger filter to begin suppression.
`void`	`setFileContents(FileContents fileContents)` Set the FileContents for this filter.
`void`	`setIdFormat(String format)` Setter to specify check ID pattern to suppress.
`void`	`setInfluenceFormat(String format)` Setter to specify negative/zero/positive value that defines the number of lines preceding/at/following the suppression comment.
`void`	`setMessageFormat(String format)` Setter to define message pattern to suppress.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SuppressWithNearbyCommentFilter
```
public SuppressWithNearbyCommentFilter()
```
- Method Detail
  - setCommentFormat
```
public final void setCommentFormat(Pattern pattern)
```
    Setter to specify comment pattern to trigger filter to begin suppression.
    
    Parameters:
    
    pattern - a pattern.
  - 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)
```
    Setter to specify check pattern to suppress.
    
    Parameters:
    
    format - a String value
  - setMessageFormat
```
public void setMessageFormat(String format)
```
    Setter to define message pattern to suppress.
    
    Parameters:
    
    format - a String value
  - setIdFormat
```
public void setIdFormat(String format)
```
    Setter to specify check ID pattern to suppress.
    
    Parameters:
    
    format - a String value
  - setInfluenceFormat
```
public final void setInfluenceFormat(String format)
```
    Setter to specify negative/zero/positive value that defines the number of lines preceding/at/following the suppression comment.
    
    Parameters:
    
    format - a String value
  - setCheckCPP
```
public void setCheckCPP(boolean checkCpp)
```
    Setter to control whether to check C++ style comments (//).
    
    Parameters:
    
    checkCpp - true if C++ comments are checked.
  - setCheckC
```
public void setCheckC(boolean checkC)
```
    Setter to control whether to check C style comments (/* ... */).
    
    Parameters:
    
    checkC - true if C comments are checked.
  - finishLocalSetup
```
protected void finishLocalSetup()
```
    Description copied from class: AutomaticBean
    
    Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.
    The default implementation does nothing.
    
    Specified by:
    
    finishLocalSetup in class AutomaticBean
  - accept
```
public boolean accept(TreeWalkerAuditEvent event)
```
    Description copied from interface: TreeWalkerFilter
    
    Determines whether or not a filtered TreeWalkerAuditEvent is accepted.
    
    Specified by:
    
    accept in interface TreeWalkerFilter
    
    Parameters:
    
    event - the TreeWalkerAuditEvent to filter.
    
    Returns:
    
    true if the event is accepted.

Class SuppressWithNearbyCommentFilter

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

Constructor Summary

Method Summary

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

Methods inherited from class java.lang.Object

Constructor Detail

SuppressWithNearbyCommentFilter

Method Detail

setCommentFormat

setFileContents

setCheckFormat

setMessageFormat

setIdFormat

setInfluenceFormat

setCheckCPP

setCheckC

finishLocalSetup

accept