rspec/rules/S2921/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

71 lines
1.8 KiB
Plaintext

== Why is this an issue?
If you go to the trouble of importing a symbol statically, then you should make use of it, and you should do so consistently. Similarly, there's no reason to both import a class and then refer to it in code by its fully-qualified name. Otherwise, maintainers could be confused by the difference between qualified and unqualified references.
=== Noncompliant code example
[source,java]
----
import java.util.*;
import java.math.BigInteger;
import static java.lang.String.format;
//...
String s1 = format("%cello %cellow", 'h','f'); // Compliant
String s2 = String.format("%cello %cellow", 'm','y'); // Noncompliant; is this a different format function than on the previous line?
java.util.List<String> list = new java.util.ArrayList<String>(); // Noncompliant; both classes included in java.util.* import
java.math.BigInteger myBigI = BigInteger.ZERO; // Noncompliant. This mixed usage is particularly confusing
----
=== Compliant solution
[source,java]
----
import java.util.*;
import java.math.BigInteger;
import static java.lang.String.format;
//...
String s1 = format("%cello %cellow", 'h','f');
String s2 = format("%cello %cellow", 'm','y');
List<String> list = new ArrayList<String>();
BigInteger myBigI = BigInteger.ZERO;
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Simplify this use to "xxx".
'''
== Comments And Links
(visible only on this page)
=== on 8 May 2015, 15:12:38 Ann Campbell wrote:
source: email thread
=== on 8 May 2015, 15:54:23 Nicolas Peru wrote:
Looks fine.
=== on 10 Jun 2015, 15:10:10 Ann Campbell wrote:
\[~nicolas.peru], scope expanded since previous review
=== on 16 Jun 2015, 17:03:53 Nicolas Peru wrote:
Looks good !
endif::env-github,rspecator-view[]