diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/HideUtilityClassConstructorCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/HideUtilityClassConstructorCheck.java index 0f6d0a43a21..6a20d1456d4 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/HideUtilityClassConstructorCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/HideUtilityClassConstructorCheck.java @@ -19,10 +19,14 @@ package com.puppycrawl.tools.checkstyle.checks.design; +import java.util.Collections; +import java.util.Set; + import com.puppycrawl.tools.checkstyle.StatelessCheck; import com.puppycrawl.tools.checkstyle.api.AbstractCheck; import com.puppycrawl.tools.checkstyle.api.DetailAST; import com.puppycrawl.tools.checkstyle.api.TokenTypes; +import com.puppycrawl.tools.checkstyle.utils.AnnotationUtil; /** *
@@ -53,6 +57,19 @@ * } * } * + * * *

* Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker} @@ -78,6 +95,33 @@ public class HideUtilityClassConstructorCheck extends AbstractCheck { */ public static final String MSG_KEY = "hide.utility.class"; + /** + * Ignore classes annotated with the specified annotation(s). Annotation names + * provided in this property must exactly match the annotation names on the classes. + * If the target class has annotations specified with their fully qualified names + * (including package), the annotations in this property should also be specified with + * their fully qualified names. Similarly, if the target class has annotations specified + * with their simple names, this property should contain the annotations with the same + * simple names. + */ + private Set ignoreAnnotatedBy = Collections.emptySet(); + + /** + * Setter to ignore classes annotated with the specified annotation(s). Annotation names + * provided in this property must exactly match the annotation names on the classes. + * If the target class has annotations specified with their fully qualified names + * (including package), the annotations in this property should also be specified with + * their fully qualified names. Similarly, if the target class has annotations specified + * with their simple names, this property should contain the annotations with the same + * simple names. + * + * @param annotationNames specified annotation(s) + * @since 10.20.0 + */ + public void setIgnoreAnnotatedBy(String... annotationNames) { + ignoreAnnotatedBy = Set.of(annotationNames); + } + @Override public int[] getDefaultTokens() { return getRequiredTokens(); @@ -96,7 +140,7 @@ public int[] getRequiredTokens() { @Override public void visitToken(DetailAST ast) { // abstract class could not have private constructor - if (!isAbstract(ast)) { + if (!isAbstract(ast) && !shouldIgnoreClass(ast)) { final boolean hasStaticModifier = isStatic(ast); final Details details = new Details(ast); @@ -146,6 +190,16 @@ private static boolean isStatic(DetailAST ast) { .findFirstToken(TokenTypes.LITERAL_STATIC) != null; } + /** + * Checks if class is annotated by specific annotation(s) to skip. + * + * @param ast class to check + * @return true if annotated by ignored annotations + */ + private boolean shouldIgnoreClass(DetailAST ast) { + return AnnotationUtil.containsAnnotation(ast, ignoreAnnotatedBy); + } + /** * Details of class that are required for validation. */ diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/design/HideUtilityClassConstructorCheck.xml b/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/design/HideUtilityClassConstructorCheck.xml index 3c6496fc314..7ac13afbeff 100644 --- a/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/design/HideUtilityClassConstructorCheck.xml +++ b/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/design/HideUtilityClassConstructorCheck.xml @@ -32,6 +32,17 @@ } } </pre> + + + Ignore classes annotated + with the specified annotation(s). Annotation names provided in this property + must exactly match the annotation names on the classes. If the target class has annotations + specified with their fully qualified names (including package), the annotations in this + property should also be specified with their fully qualified names. Similarly, if the target + class has annotations specified with their simple names, this property should contain the + annotations with the same simple names. + + diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/checks/design/HideUtilityClassConstructorCheckTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/checks/design/HideUtilityClassConstructorCheckTest.java index 347c5ba6a3a..7e6d4c32102 100644 --- a/src/test/java/com/puppycrawl/tools/checkstyle/checks/design/HideUtilityClassConstructorCheckTest.java +++ b/src/test/java/com/puppycrawl/tools/checkstyle/checks/design/HideUtilityClassConstructorCheckTest.java @@ -146,4 +146,26 @@ public void testGetAcceptableTokens() { .isEqualTo(expected); } + @Test + public void testIgnoreAnnotatedBy() throws Exception { + final String[] expected = { + "30:1: " + getCheckMessage(MSG_KEY), + }; + verifyWithInlineConfigParser( + getPath("InputHideUtilityClassConstructorIgnoreAnnotationBy.java"), + expected + ); + } + + @Test + public void testIgnoreAnnotatedByFullQualifier() throws Exception { + final String[] expected = { + "9:1: " + getCheckMessage(MSG_KEY), + }; + verifyWithInlineConfigParser( + getPath("InputHideUtilityClassConstructor" + + "IgnoreAnnotationByFullyQualifiedName.java"), + expected + ); + } } diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/checks/design/hideutilityclassconstructor/InputHideUtilityClassConstructorIgnoreAnnotationBy.java b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/design/hideutilityclassconstructor/InputHideUtilityClassConstructorIgnoreAnnotationBy.java new file mode 100644 index 00000000000..fc7518d0d91 --- /dev/null +++ b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/design/hideutilityclassconstructor/InputHideUtilityClassConstructorIgnoreAnnotationBy.java @@ -0,0 +1,46 @@ +/* +HideUtilityClassConstructor +ignoreAnnotatedBy = Skip, SkipWithParam, SkipWithAnnotationAsParam + +*/ + +package com.puppycrawl.tools.checkstyle.checks.design.hideutilityclassconstructor; + +@Skip +public class InputHideUtilityClassConstructorIgnoreAnnotationBy { + public static void func() {} +} + +@SkipWithParam(name = "tool1") +class ToolClass1 { + public static void func() {} +} + +@SkipWithAnnotationAsParam(skip = @Skip) +class ToolClass2 { + public static void func() {} +} + +@CommonAnnot +@Skip +class ToolClass3 { + public static void func() {} +} + +@CommonAnnot // violation, should not have a public or default constructor +class ToolClass4 { + public static void func() {} +} + + +@interface Skip {} + +@interface SkipWithParam { + String name(); +} + +@interface SkipWithAnnotationAsParam { + Skip skip(); +} + +@interface CommonAnnot {} diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/checks/design/hideutilityclassconstructor/InputHideUtilityClassConstructorIgnoreAnnotationByFullyQualifiedName.java b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/design/hideutilityclassconstructor/InputHideUtilityClassConstructorIgnoreAnnotationByFullyQualifiedName.java new file mode 100644 index 00000000000..226379f5073 --- /dev/null +++ b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/design/hideutilityclassconstructor/InputHideUtilityClassConstructorIgnoreAnnotationByFullyQualifiedName.java @@ -0,0 +1,19 @@ +/* +HideUtilityClassConstructor +ignoreAnnotatedBy = java.lang.Deprecated + +*/ + +package com.puppycrawl.tools.checkstyle.checks.design.hideutilityclassconstructor; + +@Deprecated // violation, should not have a public or default constructor +public class InputHideUtilityClassConstructorIgnoreAnnotationByFullyQualifiedName { + public static void func() {} +} + +@java.lang.Deprecated +class DeprecatedClass { + public static void func() {} +} + +@interface Deprecated {} diff --git a/src/xdocs-examples/java/com/puppycrawl/tools/checkstyle/checks/design/HideUtilityClassConstructorCheckExamplesTest.java b/src/xdocs-examples/java/com/puppycrawl/tools/checkstyle/checks/design/HideUtilityClassConstructorCheckExamplesTest.java index 2537e6182b6..dc38388ac06 100644 --- a/src/xdocs-examples/java/com/puppycrawl/tools/checkstyle/checks/design/HideUtilityClassConstructorCheckExamplesTest.java +++ b/src/xdocs-examples/java/com/puppycrawl/tools/checkstyle/checks/design/HideUtilityClassConstructorCheckExamplesTest.java @@ -35,10 +35,20 @@ protected String getPackageLocation() { @Test public void testExample1() throws Exception { final String[] expected = { - "12:1: " + getCheckMessage(MSG_KEY), - "37:1: " + getCheckMessage(MSG_KEY), + "13:1: " + getCheckMessage(MSG_KEY), + "39:1: " + getCheckMessage(MSG_KEY), + "45:1: " + getCheckMessage(MSG_KEY), }; verifyWithInlineConfigParser(getPath("Example1.java"), expected); } + + @Test + public void testExample2() throws Exception { + final String[] expected = { + "42:1: " + getCheckMessage(MSG_KEY), + }; + + verifyWithInlineConfigParser(getPath("Example2.java"), expected); + } } diff --git a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/design/hideutilityclassconstructor/Example1.java b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/design/hideutilityclassconstructor/Example1.java index 0af95eb74bb..f5e59ef4c70 100644 --- a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/design/hideutilityclassconstructor/Example1.java +++ b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/design/hideutilityclassconstructor/Example1.java @@ -9,7 +9,9 @@ package com.puppycrawl.tools.checkstyle.checks.design.hideutilityclassconstructor; // xdoc section -- start -class Example1 { // violation +// violation below, 'should not have a public or default constructor' +@java.lang.Deprecated +class Example1 { public Example1() { } @@ -18,7 +20,7 @@ public static void fun() { } } -class Foo { // OK +class Foo { private Foo() { } @@ -26,7 +28,7 @@ private Foo() { static int n; } -class Bar { // OK +class Bar { protected Bar() { // prevents calls from subclass @@ -34,8 +36,17 @@ protected Bar() { } } -class UtilityClass { // violation +@Deprecated // violation, 'should not have a public or default constructor' +class UtilityClass { static float f; } +// violation below, 'should not have a public or default constructor' +@SpringBootApplication +class Application1 { + + public static void main(String[] args) { + } +} // xdoc section -- end +@interface SpringBootApplication {} diff --git a/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/design/hideutilityclassconstructor/Example2.java b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/design/hideutilityclassconstructor/Example2.java new file mode 100644 index 00000000000..e1576c7db3a --- /dev/null +++ b/src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/design/hideutilityclassconstructor/Example2.java @@ -0,0 +1,54 @@ +/*xml + + + + + + + +*/ + +package com.puppycrawl.tools.checkstyle.checks.design.hideutilityclassconstructor; + +// xdoc section -- start +// ok below, skipped by annotation +@java.lang.Deprecated +class Example2 { + + public Example2() { + } + + public static void fun() { + } +} + +class Foo2 { + + private Foo2() { + } + + static int n; +} + +class Bar2 { + + protected Bar2() { + // prevents calls from subclass + throw new UnsupportedOperationException(); + } +} + +@Deprecated // violation, 'should not have a public or default constructor' +class UtilityClass2 { + + static float f; +} +// ok below, skipped by annotation +@SpringBootApplication +class Application2 { + + public static void main(String[] args) { + } +} +// xdoc section -- end diff --git a/src/xdocs/checks/design/hideutilityclassconstructor.xml b/src/xdocs/checks/design/hideutilityclassconstructor.xml index c213e0ac8c8..20b792de220 100644 --- a/src/xdocs/checks/design/hideutilityclassconstructor.xml +++ b/src/xdocs/checks/design/hideutilityclassconstructor.xml @@ -42,6 +42,27 @@ public class StringUtils // not final to allow subclassing + +

+ + + + + + + + + + + + + + + +
namedescriptiontypedefault valuesince
ignoreAnnotatedByIgnore classes annotated with the specified annotation(s). Annotation names provided in this property must exactly match the annotation names on the classes. If the target class has annotations specified with their fully qualified names (including package), the annotations in this property should also be specified with their fully qualified names. Similarly, if the target class has annotations specified with their simple names, this property should contain the annotations with the same simple names.String[]{}10.20.0
+
+ +

To configure the check: @@ -55,7 +76,9 @@ public class StringUtils // not final to allow subclassing

Example:

-class Example1 { // violation +// violation below, 'should not have a public or default constructor' +@java.lang.Deprecated +class Example1 { public Example1() { } @@ -64,7 +87,7 @@ class Example1 { // violation } } -class Foo { // OK +class Foo { private Foo() { } @@ -72,7 +95,7 @@ class Foo { // OK static int n; } -class Bar { // OK +class Bar { protected Bar() { // prevents calls from subclass @@ -80,9 +103,74 @@ class Bar { // OK } } -class UtilityClass { // violation +@Deprecated // violation, 'should not have a public or default constructor' +class UtilityClass { + + static float f; +} +// violation below, 'should not have a public or default constructor' +@SpringBootApplication +class Application1 { + + public static void main(String[] args) { + } +} + + +

+ To configure the check to ignore classes annotated with SpringBootApplication + or java.lang.Deprecated. +

+ +<module name="Checker"> + <module name="TreeWalker"> + <module name="HideUtilityClassConstructor"> + <property name="ignoreAnnotatedBy" + value="SpringBootApplication, java.lang.Deprecated" /> + </module> + </module> +</module> + +

Example:

+ +// ok below, skipped by annotation +@java.lang.Deprecated +class Example2 { + + public Example2() { + } + + public static void fun() { + } +} + +class Foo2 { + + private Foo2() { + } + + static int n; +} + +class Bar2 { + + protected Bar2() { + // prevents calls from subclass + throw new UnsupportedOperationException(); + } +} + +@Deprecated // violation, 'should not have a public or default constructor' +class UtilityClass2 { static float f; +} +// ok below, skipped by annotation +@SpringBootApplication +class Application2 { + + public static void main(String[] args) { + } }
diff --git a/src/xdocs/checks/design/hideutilityclassconstructor.xml.template b/src/xdocs/checks/design/hideutilityclassconstructor.xml.template index 0d65fc66576..c0bea4ac61d 100644 --- a/src/xdocs/checks/design/hideutilityclassconstructor.xml.template +++ b/src/xdocs/checks/design/hideutilityclassconstructor.xml.template @@ -42,6 +42,15 @@ public class StringUtils // not final to allow subclassing + +
+ + + +
+
+

To configure the check: @@ -57,6 +66,22 @@ public class StringUtils // not final to allow subclassing value="resources/com/puppycrawl/tools/checkstyle/checks/design/hideutilityclassconstructor/Example1.java"/> + +

+ To configure the check to ignore classes annotated with SpringBootApplication + or java.lang.Deprecated. +

+ + + + +

Example:

+ + + +