hiifong/pmd
1
0
Fork 0
forked from phoedos/pmd
Code Pull Requests Activity

Revamp MissingStaticMethodInNonInstantiatableClass

Browse Source 
- Somewhat simplify the XPath
 - Make it more robust:
   - private static methods are not ok
   - Check actual return statement types rather than the method signature, as inheritance may muddy the waters
   - We don't need the methods from the nested class to be public, just not private
   - Same applies to the nested class itself
This commit is contained in:
Juan Martín Sotuyo Dodero
2023-01-28 14:15:18 -03:00
parent 648d4e9a24
commit c93f4cad9b
1 changed files with 37 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
pmd-java/src/main/resources/category/java/errorprone.xml
View File

@ -2351,52 +2351,44 @@ See the property `annotations`.
<property name="xpath">
<value>
<![CDATA[
//ClassOrInterfaceDeclaration
[pmd-java:hasAnnotation('lombok.experimental.UtilityClass')]
[ClassOrInterfaceBody
[
(: no methods :)
not(MethodDeclaration)
or
(: only private methods :)
count(MethodDeclaration) = count(MethodDeclaration[@Private=true()])
]
]
|
//ClassOrInterfaceDeclaration[@Nested= false() and @Local= false()]
(: no lombok constructor annotations :)
[not(pmd-java:hasAnnotation('lombok.NoArgsConstructor') or
pmd-java:hasAnnotation('lombok.RequiredArgsConstructor') or
pmd-java:hasAnnotation('lombok.AllArgsConstructor'))]
[
(: at least one constructor :) ./ClassOrInterfaceBody/ConstructorDeclaration
and
(: only private constructors :) count(./ClassOrInterfaceBody/ConstructorDeclaration) = count(./ClassOrInterfaceBody/ConstructorDeclaration[pmd-java:modifiers() = "private"])
and
(: all constructors must not be annotated :)
(every $x in $annotations satisfies
not(./ClassOrInterfaceBody/ConstructorDeclaration/ModifierList/Annotation[pmd-java:typeIs($x)]))
]
(: no static methods :)
[not(.//MethodDeclaration[pmd-java:modifiers() = "static"])]
(: no (public, package-private, protected) static fields :)
[not(.//FieldDeclaration[not(pmd-java:modifiers() = "private")][pmd-java:modifiers() = "static"])]
(: no nested classes, that are public and static, and have no constructors at all or a public constructor :)
(: and have a method returning the outer class type :)
(: or the inner class extends the outer class :)
[not(.//ClassOrInterfaceDeclaration[@Nested = true()]
[pmd-java:modifiers() = ("public", "static")]
[not(./ClassOrInterfaceBody/ConstructorDeclaration) or ./ClassOrInterfaceBody/ConstructorDeclaration[pmd-java:modifiers() = "public"]]
[(./ClassOrInterfaceBody/MethodDeclaration
[pmd-java:modifiers() = "public"]
[.//ClassOrInterfaceType
[@SimpleName = //ClassOrInterfaceDeclaration[@Nested = false()]/@SimpleName]
]
) or (
./ExtendsList/ClassOrInterfaceType[@SimpleName = //ClassOrInterfaceDeclaration[@Nested = false()]/@SimpleName]
)]
let $topLevelClass := //ClassOrInterfaceDeclaration[@Nested= false() and @Local= false()] return
let $isLombokUtility := exists($topLevelClass[pmd-java:hasAnnotation('lombok.experimental.UtilityClass')]) return
$topLevelClass[
(: non-instantiable :)
$isLombokUtility or
(
(: no lombok produced constructors :)
not(pmd-java:hasAnnotation('lombok.NoArgsConstructor') or
pmd-java:hasAnnotation('lombok.RequiredArgsConstructor') or
pmd-java:hasAnnotation('lombok.AllArgsConstructor')) and
(: or has non-default constructors … :)
ClassOrInterfaceBody/ConstructorDeclaration and
(: … but only private … :)
not(ClassOrInterfaceBody/ConstructorDeclaration[pmd-java:modifiers() != "private"]) and
(: … and none annotated … :)
(every $x in $annotations satisfies
not(ClassOrInterfaceBody/ConstructorDeclaration/ModifierList/Annotation[pmd-java:typeIs($x)]))
)
]
]
[
(: With no visible static methods … :)
not(ClassOrInterfaceBody/MethodDeclaration[($isLombokUtility or pmd-java:modifiers() = "static") and @Visibility != "private"]) and
(: … nor fields … :)
not(ClassOrInterfaceBody/FieldDeclaration[($isLombokUtility or pmd-java:modifiers() = "static") and @Visibility != "private"]) and
(: … no nested classes, that are non-private and static … :)
not(ClassOrInterfaceBody/ClassOrInterfaceDeclaration
[pmd-java:modifiers() = "static" and @Visibility != "private"]
(: … with a default or non-private constructor … :)
[not(ClassOrInterfaceBody/ConstructorDeclaration) or ClassOrInterfaceBody/ConstructorDeclaration[pmd-java:modifiers() != "private"]]
(: … and a non-private method returning the outer class type … :)
[(ClassOrInterfaceBody/MethodDeclaration
[pmd-java:modifiers() != "private"]
[descendant::ReturnStatement/*[1][pmd-java:typeIs(ancestor::ClassOrInterfaceDeclaration[@Nested = false()]/@BinaryName)]]
) or (
(: … or the inner class extends the outer class :)
ExtendsList/ClassOrInterfaceType[@SimpleName = ancestor::ClassOrInterfaceDeclaration[@Nested = false()]/@SimpleName]
)]
)]
]]>
</value>
</property>