Issue #16332: Updated SuppressionSingleFilterExamplesTest methods to use verifyFilterWithInlineConfigParser

Author: Prarthana-Ramesh

src/site/xdoc/filters/suppressionsinglefilter.xml

@@ -93,15 +93,9 @@
       </subsection>
       <subsection name="Examples" id="Examples">
         <p id="Example1-config">
-          The following suppressions directs
-          a <code>SuppressionSingleFilter</code> to
-          reject <code>JavadocStyleCheck</code> violations for
-          lines 82 and 108 to 122 of
-          file <code>AbstractComplexityCheck.java</code>,
-          and <code>MagicNumberCheck</code> violations for line
-          221 of file <code>JavadocStyleCheck.java</code>,
-          and <code>'Missing a Javadoc comment'</code> violations
-          for all lines and files:
+          To configure a filter to suppress violations of <code>JavadocStyle</code> and
+          <code>MagicNumber</code> checks in <code>Example1.java</code> for specific line ranges
+          using <code>SuppressionSingleFilter</code>:
         </p>
         <div class="wrapper"><pre class="prettyprint"><code class="language-xml">
 &lt;module name="Checker"&gt;
@@ -110,12 +104,7 @@
     &lt;module name="MagicNumber"/&gt;
   &lt;/module&gt;
   &lt;module name="SuppressionSingleFilter"&gt;
-    &lt;property name="checks" value="JavadocStyle"/&gt;
-    &lt;property name="files" value="Example1.java"/&gt;
-    &lt;property name="lines" value="1,5-100"/&gt;
-  &lt;/module&gt;
-  &lt;module name="SuppressionSingleFilter"&gt;
-    &lt;property name="checks" value="MagicNumber"/&gt;
+    &lt;property name="checks" value="JavadocStyle|MagicNumber"/&gt;
     &lt;property name="files" value="Example1.java"/&gt;
     &lt;property name="lines" value="1,5-100"/&gt;
   &lt;/module&gt;
@@ -129,23 +118,24 @@
         <div class="wrapper"><pre class="prettyprint"><code class="language-java">
 public class Example1 {
   public void exampleMethod() {
-    int value = 100;
-    // filtered violation ''100' is a magic number'
+    int value = 100; // filtered violation ''100' is a magic number'
   }
 }
 </code></pre></div>
         <p id="Example2-config">
-          Suppress check by <a href="https://checkstyle.org/config.html#Id">module id</a>
-          when config have two instances on the same check:
+          To configure a filter to suppress violations of <code>JavadocMethod</code> and
+          <code>EqualsAvoidNull</code> checks in <code>Example2.java</code> using
+          <code>SuppressionSingleFilter</code>:
         </p>
         <div class="wrapper"><pre class="prettyprint"><code class="language-xml">
 &lt;module name="Checker"&gt;
-  &lt;module name="EqualsAvoidNull"/&gt;
-  &lt;module name="JavadocMethod"/&gt;
+  &lt;module name="TreeWalker"&gt;
+    &lt;module name="JavadocMethod"/&gt;
+    &lt;module name="EqualsAvoidNull"/&gt;
+  &lt;/module&gt;
   &lt;module name="SuppressionSingleFilter"&gt;
-    &lt;property name="id" value="stringEqual"/&gt;
     &lt;property name="files" value="Example2.java"/&gt;
-    &lt;property name="checks" value="EqualsAvoidNull, JavadocMethod"/&gt;
+    &lt;property name="checks" value="JavadocMethod|EqualsAvoidNull"/&gt;
   &lt;/module&gt;
 &lt;/module&gt;
 </code></pre></div>
@@ -154,19 +144,25 @@ public class Example1 {
         <div class="wrapper"><pre class="prettyprint"><code class="language-java">
 public class Example2 {
 
-  public void checkStringEquality(String str1, String str2) {
-    // filtered violation ''.equals()' should be used for string comparison'
-    assert str1 == str2 ;
+  public void checkStringEquality(String s) {
+    // filtered violation below 'String literal expressions should be on the left'
+    s.equals("M");
   }
+  /**
+   * @param p1 The first number
+   */
+  // filtered violation below '@return tag should be present'
+  private int m2(int p1) { return p1; }
 }
 </code></pre></div>
         <p id="Example3-config">
-          Suppress all checks for hidden files and folders:
+          To configure a filter to suppress violations of <code>RegexpSinglelineCheck</code>
+          in <code>Example3.java</code> using <code>SuppressionSingleFilter</code>:
         </p>
         <div class="wrapper"><pre class="prettyprint"><code class="language-xml">
 &lt;module name="Checker"&gt;
   &lt;module name="RegexpSingleline"&gt;
-    &lt;property name="format" value=".*example.*"/&gt;
+    &lt;property name="format" value="example"/&gt;
   &lt;/module&gt;
   &lt;module name="SuppressionSingleFilter"&gt;
     &lt;property name="files" value="Example3.java"/&gt;
@@ -180,26 +176,28 @@ public class Example2 {
 public class Example3 {
 
   public void printExample() {
-    // filtered violation 'Line matches the illegal pattern 'example''
     System.out.println(
-      "This is an example string."
+      "example" // filtered violation 'Line matches the illegal pattern 'example''
     );
   }
 
   public void noViolation() {
     System.out.println(
-      "This string does not contain 'example'."
+      "RegexpSingleline is case sensitive by default. 'Example' in not matching."
     );
   }
 
 }
 </code></pre></div>
         <p id="Example4-config">
-          Suppress all checks for Maven-generated code:
+          To configure a filter to suppress violations of <code>NoWhitespaceAfter</code>
+          in <code>Example4.java</code> using <code>SuppressionSingleFilter</code>:
         </p>
         <div class="wrapper"><pre class="prettyprint"><code class="language-xml">
 &lt;module name="Checker"&gt;
-  &lt;module name="NoWhitespaceAfter"/&gt;
+  &lt;module name="TreeWalker"&gt;
+    &lt;module name="NoWhitespaceAfter"/&gt;
+  &lt;/module&gt;
   &lt;module name="SuppressionSingleFilter"&gt;
     &lt;property name="files" value="Example4.java"/&gt;
     &lt;property name="checks" value="NoWhitespaceAfter"/&gt;
@@ -211,18 +209,20 @@ public class Example3 {
         <div class="wrapper"><pre class="prettyprint"><code class="language-java">
 public class Example4 {
 
-  // filtered violation 'WhiteSpace after ',''
   public void exampleMethod(int a, int b) {
+    // filtered violation below ''.' is followed by whitespace'
+    Integer. parseInt("3");
   }
 
   public void exampleMethod2() {
-    int x = 5 ; // filtered violation 'WhiteSpace before ';''
+    int [] x; // filtered violation ''int' is followed by whitespace'
   }
 
 }
 </code></pre></div>
         <p id="Example5-config">
-          Suppress all checks for archives, classes and other binary files:
+          To configure a filter to suppress violations of <code>MethodName</code>
+          in <code>Example5.java</code> using <code>SuppressionSingleFilter</code>:
         </p>
         <div class="wrapper"><pre class="prettyprint"><code class="language-xml">
 &lt;module name="Checker"&gt;
@@ -237,17 +237,17 @@ public class Example4 {
         </p>
         <div class="wrapper"><pre class="prettyprint"><code class="language-java">
 public class Example5 {
-  // filtered violation 'Name 'example_Method' must match pattern'
+  // filtered violation below 'Name 'example_Method' must match pattern'
   public void example_Method() {
   }
-
-  // filtered violation Name 'Another_Method' must match pattern
+  // filtered violation below 'Name 'Another_Method' must match pattern'
   public void Another_Method() {
   }
 }
 </code></pre></div>
         <p id="Example6-config">
-          Suppress all checks for image files:
+          To configure a filter to suppress violations of <code>ConstantName</code>
+          in <code>Example6.java</code> using <code>SuppressionSingleFilter</code>:
         </p>
         <div class="wrapper"><pre class="prettyprint"><code class="language-xml">
 &lt;module name="Checker"&gt;
@@ -262,42 +262,40 @@ public class Example5 {
         </p>
         <div class="wrapper"><pre class="prettyprint"><code class="language-java">
 public class Example6 {
-
-  // filtered violation 'Name 'myConstant' must match pattern'
+  // filtered violation below 'Name 'myConstant' must match pattern'
   private static final int myConstant = 42;
 
 }
 </code></pre></div>
         <p id="Example7-config">
-          Suppress all checks for non-java files:
+          To configure a filter to suppress violations of <code>MemberName</code>
+          and <code>MethodName</code> in <code>Example7.java</code> using
+          <code>SuppressionSingleFilter</code>:
         </p>
         <div class="wrapper"><pre class="prettyprint"><code class="language-xml">
 &lt;module name="Checker"&gt;
   &lt;module name="MemberName"/&gt;
+  &lt;module name="MethodName"/&gt;
   &lt;module name="SuppressionSingleFilter"&gt;
     &lt;property name="files" value="Example7.java"/&gt;
-    &lt;property name="checks" value="MemberName"/&gt;
+    &lt;property name="checks" value="MemberName|MethodName"/&gt;
   &lt;/module&gt;
 &lt;/module&gt;
 </code></pre></div>
         <p id="Example7-code">
         </p>
         <div class="wrapper"><pre class="prettyprint"><code class="language-java">
 public class Example7 {
-
-  // filtered violation 'Name 'MyVariable' must match pattern'
+  // filtered violation below 'Name 'MyVariable' must match pattern'
   private int MyVariable = 5;
-
-  // filtered violation 'Name 'PrintHello' must match pattern'
-  public void PrintHello() {
-  }
-
-  public void printHello() {
+  // filtered violation below 'Name 'MyMethod' must match pattern'
+  public void MyMethod() {
   }
 }
 </code></pre></div>
         <p id="Example8-config">
-          Suppress all checks in generated sources:
+          To configure a filter to suppress <code>ParameterNumber</code> violations
+          in <code>Example8.java</code> using <code>SuppressionSingleFilter</code>:
         </p>
         <div class="wrapper"><pre class="prettyprint"><code class="language-xml">
 &lt;module name="Checker"&gt;
@@ -316,15 +314,15 @@ public class Example7 {
         </p>
         <div class="wrapper"><pre class="prettyprint"><code class="language-java">
 public class Example8 {
-  // filtered violation 'more than 5 parameters'
+  // filtered violation below 'More than 5 parameters (found 6)'
   public void exampleMethod(
-    int param1, int param2, int param3, int param4,
-    int param5
+    int param1, int param2, int param3, int param4, int param5, int param6
   ) {}
 }
 </code></pre></div>
         <p id="Example9-config">
-          Suppress FileLength check on integration tests in certain folder:
+          To configure a filter to suppress <code>FileLength</code> violations
+          in <code>Example9.java</code> using <code>SuppressionSingleFilter</code>:
         </p>
         <div class="wrapper"><pre class="prettyprint"><code class="language-xml">
 &lt;module name="Checker"&gt;
@@ -342,12 +340,14 @@ public class Example8 {
         <p id="Example9-code">
         </p>
         <div class="wrapper"><pre class="prettyprint"><code class="language-java">
+/* filtered violation on 1st line  'File length is 4 lines (max allowed is 1)' */
 public class Example9 {
-  //filtered violation 'File length is 19 lines (max allowed is 1)'
+
 }
 </code></pre></div>
         <p id="Example10-config">
-          Suppress naming violations on variable named 'log' in all files:
+          To configure a filter to suppress <code>MemberName</code> violations
+          in <code>Example10.java</code> using <code>SuppressionSingleFilter</code>:
         </p>
         <div class="wrapper"><pre class="prettyprint"><code class="language-xml">
 &lt;module name="Checker"&gt;
@@ -364,8 +364,7 @@ public class Example9 {
         </p>
         <div class="wrapper"><pre class="prettyprint"><code class="language-java">
 public class Example10 {
-
-  // filtered violation 'Name 'log' must match pattern'
+  // filtered violation below 'Name 'log' must match pattern'
   private String log = "Some log message";
 
 }

src/site/xdoc/filters/suppressionsinglefilter.xml.template

@@ -46,15 +46,9 @@
       </subsection>
       <subsection name="Examples" id="Examples">
         <p id="Example1-config">
-          The following suppressions directs
-          a <code>SuppressionSingleFilter</code> to
-          reject <code>JavadocStyleCheck</code> violations for
-          lines 82 and 108 to 122 of
-          file <code>AbstractComplexityCheck.java</code>,
-          and <code>MagicNumberCheck</code> violations for line
-          221 of file <code>JavadocStyleCheck.java</code>,
-          and <code>'Missing a Javadoc comment'</code> violations
-          for all lines and files:
+          To configure a filter to suppress violations of <code>JavadocStyle</code> and
+          <code>MagicNumber</code> checks in <code>Example1.java</code> for specific line ranges
+          using <code>SuppressionSingleFilter</code>:
         </p>
         <macro name="example">
           <param name="path"
@@ -69,8 +63,9 @@
           <param name="type" value="code"/>
         </macro>
         <p id="Example2-config">
-          Suppress check by <a href="https://checkstyle.org/config.html#Id">module id</a>
-          when config have two instances on the same check:
+          To configure a filter to suppress violations of <code>JavadocMethod</code> and
+          <code>EqualsAvoidNull</code> checks in <code>Example2.java</code> using
+          <code>SuppressionSingleFilter</code>:
         </p>
         <macro name="example">
           <param name="path"
@@ -85,7 +80,8 @@
           <param name="type" value="code"/>
         </macro>
         <p id="Example3-config">
-          Suppress all checks for hidden files and folders:
+          To configure a filter to suppress violations of <code>RegexpSinglelineCheck</code>
+          in <code>Example3.java</code> using <code>SuppressionSingleFilter</code>:
         </p>
         <macro name="example">
           <param name="path"
@@ -100,7 +96,8 @@
           <param name="type" value="code"/>
         </macro>
         <p id="Example4-config">
-          Suppress all checks for Maven-generated code:
+          To configure a filter to suppress violations of <code>NoWhitespaceAfter</code>
+          in <code>Example4.java</code> using <code>SuppressionSingleFilter</code>:
         </p>
         <macro name="example">
           <param name="path"
@@ -115,7 +112,8 @@
           <param name="type" value="code"/>
         </macro>
         <p id="Example5-config">
-          Suppress all checks for archives, classes and other binary files:
+          To configure a filter to suppress violations of <code>MethodName</code>
+          in <code>Example5.java</code> using <code>SuppressionSingleFilter</code>:
         </p>
         <macro name="example">
           <param name="path"
@@ -130,7 +128,8 @@
           <param name="type" value="code"/>
         </macro>
         <p id="Example6-config">
-          Suppress all checks for image files:
+          To configure a filter to suppress violations of <code>ConstantName</code>
+          in <code>Example6.java</code> using <code>SuppressionSingleFilter</code>:
         </p>
         <macro name="example">
           <param name="path"
@@ -145,7 +144,9 @@
           <param name="type" value="code"/>
         </macro>
         <p id="Example7-config">
-          Suppress all checks for non-java files:
+          To configure a filter to suppress violations of <code>MemberName</code>
+          and <code>MethodName</code> in <code>Example7.java</code> using
+          <code>SuppressionSingleFilter</code>:
         </p>
         <macro name="example">
           <param name="path"
@@ -160,7 +161,8 @@
           <param name="type" value="code"/>
         </macro>
         <p id="Example8-config">
-          Suppress all checks in generated sources:
+          To configure a filter to suppress <code>ParameterNumber</code> violations
+          in <code>Example8.java</code> using <code>SuppressionSingleFilter</code>:
         </p>
         <macro name="example">
           <param name="path"
@@ -175,7 +177,8 @@
           <param name="type" value="code"/>
         </macro>
         <p id="Example9-config">
-          Suppress FileLength check on integration tests in certain folder:
+          To configure a filter to suppress <code>FileLength</code> violations
+          in <code>Example9.java</code> using <code>SuppressionSingleFilter</code>:
         </p>
         <macro name="example">
           <param name="path"
@@ -190,7 +193,8 @@
           <param name="type" value="code"/>
         </macro>
         <p id="Example10-config">
-          Suppress naming violations on variable named 'log' in all files:
+          To configure a filter to suppress <code>MemberName</code> violations
+          in <code>Example10.java</code> using <code>SuppressionSingleFilter</code>:
         </p>
         <macro name="example">
           <param name="path"