rspec/rules/S1118/java/rule.adoc

36 lines
924 B
Plaintext
Raw Normal View History

2021-01-27 13:42:22 +01:00
Utility classes, which are collections of ``++stati{cpp}`` members, are not meant to be instantiated. Even abstract utility classes, which can be extended, should not have public constructors.
2020-06-30 12:47:33 +02:00
Java adds an implicit public constructor to every class which does not define at least one explicitly. Hence, at least one non-public constructor should be defined.
== Noncompliant Code Example
----
class StringUtils { // Noncompliant
public static String concatenate(String s1, String s2) {
return s1 + s2;
}
}
----
== Compliant Solution
----
class StringUtils { // Compliant
private StringUtils() {
throw new IllegalStateException("Utility class");
}
public static String concatenate(String s1, String s2) {
return s1 + s2;
}
}
----
== Exceptions
2021-01-27 13:42:22 +01:00
When class contains ``++public static void main(String[] args)++`` method it is not considered as utility class and will be ignored by this rule.