rspec/rules/S2208/java/rule.adoc

53 lines
1.1 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
Blindly importing all the classes in a package clutters the class namespace and could lead to conflicts between classes in different packages with the same name. On the other hand, specifically listing the necessary classes avoids that problem and makes clear which versions were wanted.
2020-06-30 12:48:07 +02:00
=== Noncompliant code example
2020-06-30 12:48:07 +02:00
2022-02-04 17:28:24 +01:00
[source,java]
2020-06-30 12:48:07 +02:00
----
import java.sql.*; // Noncompliant
import java.util.*; // Noncompliant
private Date date; // Date class exists in java.sql and java.util. Which one is this?
----
=== Compliant solution
2020-06-30 12:48:07 +02:00
2022-02-04 17:28:24 +01:00
[source,java]
2020-06-30 12:48:07 +02:00
----
import java.sql.Date;
import java.util.List;
import java.util.ArrayList;
private Date date;
----
=== Exceptions
2020-06-30 12:48:07 +02:00
Static imports are ignored by this rule. E.G.
[source,java]
2020-06-30 12:48:07 +02:00
----
import static java.lang.Math.*;
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Explicitly import the specific classes needed.
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]