diff --git a/src/xdocs-examples/java/com/puppycrawl/tools/checkstyle/filters/SuppressionXpathSingleFilterExamplesTest.java b/src/xdocs-examples/java/com/puppycrawl/tools/checkstyle/filters/SuppressionXpathSingleFilterExamplesTest.java index 6a06fc0b26c..50b13093b55 100644 --- a/src/xdocs-examples/java/com/puppycrawl/tools/checkstyle/filters/SuppressionXpathSingleFilterExamplesTest.java +++ b/src/xdocs-examples/java/com/puppycrawl/tools/checkstyle/filters/SuppressionXpathSingleFilterExamplesTest.java @@ -19,12 +19,10 @@ package com.puppycrawl.tools.checkstyle.filters; -import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport; -@Disabled("until https://github.com/checkstyle/checkstyle/issues/13345") public class SuppressionXpathSingleFilterExamplesTest extends AbstractExamplesModuleTestSupport { @Override protected String getPackageLocation() { @@ -37,7 +35,7 @@ public void testExample1() throws Exception { }; - verifyWithInlineConfigParser(getPath("Example1.txt"), expected); + verifyWithInlineConfigParser(getPath("Example1.java"), expected); } @Test @@ -46,7 +44,7 @@ public void testExample2() throws Exception { }; - verifyWithInlineConfigParser(getPath("Example2.txt"), expected); + verifyWithInlineConfigParser(getPath("Example2.java"), expected); } @Test @@ -55,7 +53,7 @@ public void testExample3() throws Exception { }; - verifyWithInlineConfigParser(getPath("Example3.txt"), expected); + verifyWithInlineConfigParser(getPath("Example3.java"), expected); } @Test @@ -64,7 +62,7 @@ public void testExample4() throws Exception { }; - verifyWithInlineConfigParser(getPath("Example4.txt"), expected); + verifyWithInlineConfigParser(getPath("Example4.java"), expected); } @Test @@ -73,7 +71,7 @@ public void testExample5() throws Exception { }; - verifyWithInlineConfigParser(getPath("Example5.txt"), expected); + verifyWithInlineConfigParser(getPath("Example5.java"), expected); } @Test @@ -82,7 +80,7 @@ public void testExample6() throws Exception { }; - verifyWithInlineConfigParser(getPath("Example6.txt"), expected); + verifyWithInlineConfigParser(getPath("Example6.java"), expected); } @Test @@ -91,7 +89,7 @@ public void testExample7() throws Exception { }; - verifyWithInlineConfigParser(getPath("Example7.txt"), expected); + verifyWithInlineConfigParser(getPath("Example7.java"), expected); } @Test @@ -100,7 +98,7 @@ public void testExample8() throws Exception { }; - verifyWithInlineConfigParser(getPath("Example8.txt"), expected); + verifyWithInlineConfigParser(getPath("Example8.java"), expected); } @Test @@ -109,7 +107,7 @@ public void testExample9() throws Exception { }; - verifyWithInlineConfigParser(getPath("Example9.txt"), expected); + verifyWithInlineConfigParser(getPath("Example9.java"), expected); } @Test @@ -118,7 +116,7 @@ public void testExample10() throws Exception { }; - verifyWithInlineConfigParser(getPath("Example10.txt"), expected); + verifyWithInlineConfigParser(getPath("Example10.java"), expected); } @Test @@ -127,7 +125,7 @@ public void testExample11() throws Exception { }; - verifyWithInlineConfigParser(getPath("Example11.txt"), expected); + verifyWithInlineConfigParser(getPath("Example11.java"), expected); } @Test @@ -136,7 +134,7 @@ public void testExample12() throws Exception { }; - verifyWithInlineConfigParser(getPath("Example12.txt"), expected); + verifyWithInlineConfigParser(getPath("Example12.java"), expected); } @Test @@ -145,7 +143,7 @@ public void testExample13() throws Exception { }; - verifyWithInlineConfigParser(getPath("Example13.txt"), expected); + verifyWithInlineConfigParser(getPath("Example13.java"), expected); } @Test @@ -154,6 +152,6 @@ public void testExample14() throws Exception { }; - verifyWithInlineConfigParser(getPath("Example14.txt"), expected); + verifyWithInlineConfigParser(getPath("Example14.java"), expected); } } diff --git a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example1.java b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example1.java new file mode 100644 index 00000000000..aa836a43834 --- /dev/null +++ b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example1.java @@ -0,0 +1,14 @@ +// xdoc section -- start +public class FileOne { + public void MyMethod() {} // OK +} + +public class FileTwo { + public void MyMethod() {} // OK +} + +public class FileThree { + public void MyMethod() {} // violation, name 'MyMethod' + // must match pattern '^[a-z](_?[a-zA-Z0-9]+)*$' +} +// xdoc section -- end diff --git a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example1.txt b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example1.txt deleted file mode 100644 index f785dcccc7f..00000000000 --- a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example1.txt +++ /dev/null @@ -1,28 +0,0 @@ -/*xml - - - - - - - - - -*/ - -// xdoc section -- start -public class FileOne { - public void MyMethod() {} // OK -} - -public class FileTwo { - public void MyMethod() {} // OK -} - -public class FileThree { - public void MyMethod() {} // violation, name 'MyMethod' - // must match pattern '^[a-z](_?[a-zA-Z0-9]+)*$' -} -// xdoc section -- end diff --git a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example10.txt b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example10.java similarity index 100% rename from src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example10.txt rename to src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example10.java diff --git a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example11.txt b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example11.java similarity index 100% rename from src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example11.txt rename to src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example11.java diff --git a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example12.txt b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example12.java similarity index 100% rename from src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example12.txt rename to src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example12.java diff --git a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example13.txt b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example13.java similarity index 100% rename from src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example13.txt rename to src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example13.java diff --git a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example14.txt b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example14.java similarity index 100% rename from src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example14.txt rename to src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example14.java diff --git a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example2.txt b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example2.java similarity index 100% rename from src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example2.txt rename to src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example2.java diff --git a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example3.txt b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example3.java similarity index 100% rename from src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example3.txt rename to src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example3.java diff --git a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example4.txt b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example4.java similarity index 100% rename from src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example4.txt rename to src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example4.java diff --git a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example5.txt b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example5.java similarity index 100% rename from src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example5.txt rename to src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example5.java diff --git a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example6.txt b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example6.java similarity index 100% rename from src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example6.txt rename to src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example6.java diff --git a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example7.txt b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example7.java similarity index 100% rename from src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example7.txt rename to src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example7.java diff --git a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example8.txt b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example8.java similarity index 100% rename from src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example8.txt rename to src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example8.java diff --git a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example9.txt b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example9.java similarity index 100% rename from src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example9.txt rename to src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example9.java diff --git a/src/xdocs/filters/suppressionxpathsinglefilter.xml b/src/xdocs/filters/suppressionxpathsinglefilter.xml index 4682278f3f7..969eeb9a0ca 100644 --- a/src/xdocs/filters/suppressionxpathsinglefilter.xml +++ b/src/xdocs/filters/suppressionxpathsinglefilter.xml @@ -113,8 +113,8 @@ public class FileTwo { } public class FileThree { - public void MyMethod() {} // violation, name 'MyMethod' - // must match pattern '^[a-z](_?[a-zA-Z0-9]+)*$' + public void MyMethod() {} + // violation, name 'MyMethod' must match pattern '^[a-z](_?[a-zA-Z0-9]+)*$' }

@@ -135,8 +135,8 @@ public class FileThree { public class FileOne { public void MyMethod1() {} // OK public void MyMethod2() {} // OK - public void MyMethodA() {} // violation, name 'MyMethodA' must - // match pattern '^[a-z](_?[a-zA-Z0-9]+)*$' + public void MyMethodA() {} + // violation, name 'MyMethodA' must match pattern '^[a-z](_?[a-zA-Z0-9]+)*$' }

@@ -162,8 +162,8 @@ public class FileOne { public void MyMethod() {} // OK } public class FileTwo { - public void MyMethod() {} // violation, name 'MyMethod' must - //match pattern '^[a-z](_?[a-zA-Z0-9]+)*$' + public void MyMethod() {} + // violation, name 'MyMethod' must match pattern '^[a-z](_?[a-zA-Z0-9]+)*$' }

@@ -224,8 +224,8 @@ public class FileOne { } public class FileTwo { - public void MyMethod() {} // violation, name 'MyMethod' - // must match pattern '^[a-z](_?[a-zA-Z0-9]+)*$' + public void MyMethod() {} + // violation, name 'MyMethod' must match pattern '^[a-z](_?[a-zA-Z0-9]+)*$' }

@@ -250,10 +250,10 @@ abstract class FileOne { // OK public void MyMethod() {} // OK } -abstract class FileTwo { // violation of the AbstractClassName check, - // it should match the pattern "^Abstract.+$" - public void MyMethod() {} // violation, name 'MyMethod' - // must match pattern '^[a-z](_?[a-zA-Z0-9]+)*$' +abstract class FileTwo { + // violation of the AbstractClassName check, it should match the pattern "^Abstract.+$" + public void MyMethod() {} + // violation, name 'MyMethod' must match pattern '^[a-z](_?[a-zA-Z0-9]+)*$' }

@@ -275,8 +275,8 @@ abstract class FileTwo { // violation of the AbstractClassName check, public class FileOne { public void MyMethod1() {} // OK public void MyMethod2() {} // OK - public void MyMethod3() {} // violation, name 'MyMethod3' must - // match pattern '^[a-z](_?[a-zA-Z0-9]+)*$' + public void MyMethod3() {} + // violation, name 'MyMethod3' must match pattern '^[a-z](_?[a-zA-Z0-9]+)*$' }

@@ -300,8 +300,8 @@ public class FileOne { public class TestClass { public void testMethod() { final int testVariable1 = 10; // OK - final int testVariable2 = 10; // violation of the LocalFinalVariableName check, - // name 'testVariable2' must match pattern '^[A-Z][A-Z0-9]*$' + final int testVariable2 = 10; + // violation of the LocalFinalVariableName check, name 'testVariable2' must match pattern '^[A-Z][A-Z0-9]*$' } } @@ -354,7 +354,8 @@ public class InputTest { private int age = 23; public void changeAge() { - age = 24; // violation will be suppressed + age = 24; + // violation will be suppressed } } @@ -380,10 +381,12 @@ public class InputTest {

Code Example:

public class InputTest { - public void throwsMethod() throws RuntimeException { // violation will be suppressed + public void throwsMethod() throws RuntimeException { + // violation will be suppressed } - public void sampleMethod() throws RuntimeException { // will throw violation here + public void sampleMethod() throws RuntimeException { + // will throw violation here } } @@ -412,10 +415,10 @@ public class TestClass { final int num = 10; // OK } - public void TestMethod2() { // violation of the MethodName check, - // name 'TestMethod2' must match pattern '^[a-z](_?[a-zA-Z0-9]+)*$' - final int num = 10; // violation of the LocalFinalVariableName check, - // name 'num' must match pattern '^[A-Z][A-Z0-9]*$' + public void TestMethod2() { + // violation of the MethodName check, name 'TestMethod2' must match pattern '^[a-z](_?[a-zA-Z0-9]+)*$' + final int num = 10; + // violation of the LocalFinalVariableName check, name 'num' must match pattern '^[A-Z][A-Z0-9]*$' } } diff --git a/src/xdocs/filters/suppressionxpathsinglefilter.xml.template b/src/xdocs/filters/suppressionxpathsinglefilter.xml.template index 516a752960c..e4aef243c04 100644 --- a/src/xdocs/filters/suppressionxpathsinglefilter.xml.template +++ b/src/xdocs/filters/suppressionxpathsinglefilter.xml.template @@ -51,13 +51,13 @@

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example1.java"/>

Code example:

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example1.java"/>

@@ -65,13 +65,13 @@

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example2.java"/>

Code Example:

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example2.java"/>

@@ -79,13 +79,13 @@

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example3.java"/>

Code example:

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example3.java"/>

@@ -93,13 +93,13 @@

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example4.java"/>

Code example:

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example4.java"/>

@@ -107,13 +107,13 @@

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example5.java"/>

Code Example:

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example5.java"/>

@@ -121,13 +121,13 @@

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example6.java"/>

Code example:

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example6.java"/>

@@ -136,13 +136,13 @@

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example7.java"/>

Code example:

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example7.java"/>

@@ -150,13 +150,13 @@

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example8.java"/>

Code example:

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example8.java"/>

@@ -165,13 +165,13 @@

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example9.java"/>

Code Example:

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example9.java"/>

@@ -181,13 +181,13 @@

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example10.java"/>

Code Example:

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example10.java"/>

@@ -196,13 +196,13 @@

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example11.java"/>

Code Example:

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example11.java"/>

@@ -215,13 +215,13 @@

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example12.java"/>

Code Example:

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example12.java"/>

@@ -233,13 +233,13 @@

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example13.java"/>

Code Example:

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example13.java"/>

@@ -250,7 +250,7 @@

+ value="resources/com/puppycrawl/tools/checkstyle/filters/suppressionxpathsinglefilter/Example14.java"/>