From c5acf2d3c6dda03c21ab9bcb121aaa0f53e00434 Mon Sep 17 00:00:00 2001 From: Nick Mancuso Date: Sun, 10 Jul 2022 11:17:52 -0400 Subject: [PATCH] Issue #11277: update code base to have javadoc tag to explain noinspection content --- .../puppycrawl/tools/checkstyle/XmlLoader.java | 2 ++ .../checks/design/FinalClassCheck.java | 2 ++ .../checks/indentation/HandlerFactory.java | 2 ++ .../tools/checkstyle/gui/TreeTable.java | 2 ++ .../checkstyle/PackageNamesLoaderTest.java | 17 +++++++++++------ .../tools/checkstyle/api/ViolationTest.java | 7 +++++-- 6 files changed, 24 insertions(+), 8 deletions(-) diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/XmlLoader.java b/src/main/java/com/puppycrawl/tools/checkstyle/XmlLoader.java index 8624f9b2b1b..85b427a4eef 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/XmlLoader.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/XmlLoader.java @@ -45,6 +45,8 @@ *

* * @noinspection ThisEscapedInObjectConstruction + * @noinspectionreason ThisEscapedInObjectConstruction - only reference is used and not + * accessed until initialized */ public class XmlLoader extends DefaultHandler { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/FinalClassCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/FinalClassCheck.java index 21e36629849..e41d7dd79d7 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/FinalClassCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/FinalClassCheck.java @@ -338,6 +338,8 @@ private void registerAnonymousInnerClassToSuperClass(DetailAST literalNewAst, * @param countProvider the function to apply to calculate the name matching count * @return {@link Optional} of {@link ClassDesc} object of the nearest class with the same name. * @noinspection CallToStringConcatCanBeReplacedByOperator + * @noinspectionreason CallToStringConcatCanBeReplacedByOperator - operator causes + * pitest to fail */ private Optional getNearestClassWithSameName(String className, Function countProvider) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/indentation/HandlerFactory.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/indentation/HandlerFactory.java index 8ccc7f62284..308b2f7d21d 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/indentation/HandlerFactory.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/indentation/HandlerFactory.java @@ -46,6 +46,8 @@ public class HandlerFactory { * Creates a HandlerFactory. * * @noinspection OverlyCoupledMethod + * @noinspectionreason OverlyCoupledMethod - complex nature of indentation check + * requires this coupling */ public HandlerFactory() { register(TokenTypes.CASE_GROUP, CaseHandler.class); diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/gui/TreeTable.java b/src/main/java/com/puppycrawl/tools/checkstyle/gui/TreeTable.java index e5e848f5585..0b24e9c9b09 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/gui/TreeTable.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/gui/TreeTable.java @@ -60,6 +60,8 @@ * Original Source Location * * @noinspection ThisEscapedInObjectConstruction + * @noinspectionreason ThisEscapedInObjectConstruction - only reference is used and not + * accessed until initialized */ public final class TreeTable extends JTable { diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/PackageNamesLoaderTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/PackageNamesLoaderTest.java index 5c4d040cfac..1f35fdec5c5 100644 --- a/src/test/java/com/puppycrawl/tools/checkstyle/PackageNamesLoaderTest.java +++ b/src/test/java/com/puppycrawl/tools/checkstyle/PackageNamesLoaderTest.java @@ -39,11 +39,13 @@ import com.puppycrawl.tools.checkstyle.api.CheckstyleException; /** - * Custom class loader is needed to pass URLs to pretend these are loaded from the classpath - * though we can't add/change the files for testing. The class loader is nested in this class, - * so the custom class loader we are using is safe. + * Tests loading of package names from XML files. * * @noinspection ClassLoaderInstantiation + * @noinspectionreason ClassLoaderInstantiation - Custom class loader is needed to pass URLs to + * pretend these are loaded from the classpath though we can't add/change the files for + * testing. The class loader is nested in this class, so the custom class loader we + * are using is safe. */ public class PackageNamesLoaderTest extends AbstractPathTestSupport { @@ -227,10 +229,11 @@ public void testPackagesWithIoExceptionGetResources() { } /** - * Custom class loader is needed to pass URLs to pretend these are loaded from the classpath - * though we can't add/change the files for testing. + * Mocked ClassLoader for testing URL loading. * * @noinspection CustomClassloader + * @noinspectionreason CustomClassloader - needed to pass URLs to pretend these are loaded + * from the classpath though we can't add/change the files for testing */ private static class TestUrlsClassLoader extends ClassLoader { @@ -247,9 +250,11 @@ public Enumeration getResources(String name) { } /** - * Custom class loader is needed to throw an exception to test a catch statement. + * Mocked ClassLoader for testing exceptions. * * @noinspection CustomClassloader + * @noinspectionreason CustomClassloader - needed to throw an exception to + * test a catch statement */ private static class TestIoExceptionClassLoader extends ClassLoader { @Override diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/api/ViolationTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/api/ViolationTest.java index ab042882ca3..33c89973737 100644 --- a/src/test/java/com/puppycrawl/tools/checkstyle/api/ViolationTest.java +++ b/src/test/java/com/puppycrawl/tools/checkstyle/api/ViolationTest.java @@ -47,6 +47,8 @@ * so the custom class loader we are using is safe. * * @noinspection ClassLoaderInstantiation + * @noinspectionreason ClassLoaderInstantiation - Custom class loader is needed to + * pass URLs for testing */ public class ViolationTest { @@ -444,10 +446,11 @@ public void tearDown() { } /** - * Custom class loader is needed to pass URLs to pretend these are loaded from the classpath - * though we can't add/change the files for testing. + * Mocked ClassLoader for testing URL loading. * * @noinspection CustomClassloader + * @noinspectionreason CustomClassloader - needed to pass URLs to pretend these are loaded + * from the classpath though we can't add/change the files for testing */ private static class TestUrlsClassLoader extends ClassLoader {