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

45 lines
762 B
Plaintext

== Why is this an issue?
Java's ``++import++`` mechanism allows the use of simple class names. Therefore, using a class' fully qualified name in a file that ``++import++``s the class is redundant and confusing.
=== Noncompliant code example
[source,java]
----
import java.util.List;
import java.sql.Timestamp;
//...
java.util.List<String> myList; // Noncompliant
java.sql.Timestamp tStamp; // Noncompliant
----
=== Compliant solution
[source,java]
----
import java.util.List;
import java.sql.Timestamp;
//...
List<String> myList;
Timestamp tStamp;
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Replace this fully qualified name with "XXX"
endif::env-github,rspecator-view[]