Description

Notes

A suppressions XML document contains a set of suppress elements, where each suppress element can have the following attributes:

• files - a Pattern matched against the file name associated with an audit event. It is optional.
• checks - a Pattern matched against the name of the check associated with an audit event. Optional as long as id or message is specified.
• message - a Pattern matched against the message of the check associated with an audit event. Optional as long as checks or id is specified.
• id - a String matched against the check id associated with an audit event. Optional as long as checks or message is specified.
• lines - a comma-separated list of values, where each value is an int or a range of integers denoted by integer-integer. It is optional.
• columns - a comma-separated list of values, where each value is an int or a range of integers denoted by integer-integer. It is optional.

Each audit event is checked against each suppress element. It is suppressed if all specified attributes match against the audit event.

ATTENTION: filtering by message is dependent on runtime locale. If project is running in different languages it is better to avoid filtering by message.

You can download template of empty suppression filter here.

Location of the file defined in file property is checked in the following order:

1. as a filesystem location
2. if no file found, and the location starts with either http:// or https://, then it is interpreted as a URL
3. if no file found, then passed to the ClassLoader.getResource() method.

SuppressionFilter can suppress Checks that have Treewalker or Checker as parent module.

Properties

Examples

For example, the following configuration fragment directs the Checker to use a SuppressionFilter with suppressions file suppressionexample1.xml:

<module name="Checker">
  <module name="SuppressionFilter">
    <property name="file" value="suppressionexample1.xml"/>
    <property name="optional" value="false"/>
  </module>
  <module name="TreeWalker">
    <module name="JavadocStyle"/>
    <module name="MagicNumber"/>
    <module name="com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck"/>
  </module>
</module>

The following suppressions XML document directs a SuppressionFilter to reject JavadocStyleCheck violations for line 4 of file Example1.java, and MagicNumberCheck violations for lines 7 and 11 of file Example1.java, and 'Missing a Javadoc comment' violations for all lines and files:

<?xml version="1.0"?>

<!DOCTYPE suppressions PUBLIC
  "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
  "https://checkstyle.org/dtds/suppressions_1_2.dtd">

<suppressions>
  <suppress checks="JavadocStyle"
    files="Example1.java"
    lines="20"/>
  <suppress checks="MagicNumber"
    files="Example1.java"
    lines="23,27"/>
  <suppress message="Missing a Javadoc comment"/>
</suppressions>

Example:

public class Example1 {

  // filtered violation below 'First sentence should end with a period.'
  /**
   * This field a is missing period
   */
  int a = 10; // filtered violation ''10' is a magic number.'

  public void exampleMethod() {

    int num = 100; // filtered violation ''100' is a magic number.'

    if (true) {
      // violation above 'Must have at least one statement.'
    }
  }
}

Suppress check by module id when config have two instances on the same check:

<suppress id="stringEqual" files="SomeTestCode.java"/>
        

Suppress all checks for hidden files and folders:

<suppress files="[/\\]\..+" checks=".*"/>
        

Suppress all checks for Maven-generated code:

<suppress files="[/\\]target[/\\]" checks=".*"/>
        

Suppress all checks for archives, classes and other binary files:

<suppress files=".+\.(?:jar|zip|war|class|tar|bin)$" checks=".*"/>
        

Suppress all checks for image files:

<suppress files=".+\.(?:png|gif|jpg|jpeg)$" checks=".*"/>
        

Suppress all checks for non-java files:

<suppress files=".+\.(?:txt|xml|csv|sh|thrift|html|sql|eot|ttf|woff|css|png)$"
  checks=".*"/>
        

Suppress all checks in generated sources:

<suppress checks=".*" files="com[\\/]mycompany[\\/]app[\\/]gen[\\/]"/>
        

Suppress FileLength check on integration tests in certain folder:

<suppress checks="FileLength"
files="com[\\/]mycompany[\\/]app[\\/].*IT.java"/>
        

Suppress naming violations on variable named 'log' in all files:

<suppress message="Name 'log' must match pattern"/>
        

Example of Usage

• Google Style
• Sun Style
• Checkstyle Style

Package

com.puppycrawl.tools.checkstyle.filters

Parent Module

Checker