rspec/rules/S1118/java/rule.adoc

58 lines
1010 B
Plaintext
Raw Permalink Normal View History

== Why is this an issue?
2023-10-18 10:16:10 +02:00
include::../description.adoc[]
2021-02-02 15:02:10 +01:00
2023-10-18 10:16:10 +02:00
=== Exceptions
When a class contains `public static void main(String[] args)` method it is not considered as a utility class and will be ignored by this rule.
include::../howtofix.adoc[]
2020-06-30 12:47:33 +02:00
2023-10-18 10:16:10 +02:00
=== Code examples
==== Noncompliant code example
2020-06-30 12:47:33 +02:00
[source,java,diff-id=1,diff-type=noncompliant]
2020-06-30 12:47:33 +02:00
----
class StringUtils { // Noncompliant
public static String concatenate(String s1, String s2) {
return s1 + s2;
}
}
----
2023-10-18 10:16:10 +02:00
==== Compliant solution
2020-06-30 12:47:33 +02:00
[source,java,diff-id=1,diff-type=compliant]
2020-06-30 12:47:33 +02:00
----
class StringUtils { // Compliant
private StringUtils() {
throw new IllegalStateException("Utility class");
}
public static String concatenate(String s1, String s2) {
return s1 + s2;
}
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Hide this public constructor.
Add a private constructor to hide the implicit public one.
'''
endif::env-github,rspecator-view[]