rspec/rules/S3025/java/rule.adoc
Fred Tingaud 16f6c0aecf
Inline adoc when include has no additional value (#1940)
Inline adoc files when they are included exactly once.

Also fix language tags because this inlining gives us better information
on what language the code is written in.
2023-05-25 14:18:12 +02:00

64 lines
1014 B
Plaintext

== Why is this an issue?
Classes without ``++public static++`` members cannot be used without being instantiated, but classes with only ``++private++`` constructors cannot be instantiated. When a class has only ``++private++`` constructors and no ``++static++`` members, it is useless and should be removed or refactored.
=== Noncompliant code example
[source,java]
----
public class MyClass { // Noncompliant
private MyClass () {
}
public double getPi(){
return 3.14;
}
}
----
=== Compliant solution
[source,java]
----
public class MyClass {
public MyClass () {
}
public double getPi(){
return 3.14;
}
}
----
or
[source,java]
----
public class MyClass {
private MyClass () {
}
public static double getPi(){
return 3.14;
}
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Either add a public constructor or make the methods of this class "static".
endif::env-github,rspecator-view[]