rspec/rules/S2219/java/rule.adoc
Fred Tingaud 51369b610e
Make sure that includes are always surrounded by empty lines (#2270)
When an include is not surrounded by empty lines, its content is inlined
on the same line as the adjacent content. That can lead to broken tags
and other display issues.
This PR fixes all such includes and introduces a validation step that
forbids introducing the same problem again.
2023-06-22 10:38:01 +02:00

47 lines
812 B
Plaintext

== Why is this an issue?
To check the type of an object there are at least two options:
* The simplest and shortest one with help of the ``++instanceof++`` operator
* The cumbersome and error-prone one with help of the ``++Class.isAssignableFrom(...)++`` method
=== Noncompliant code example
[source,java]
----
if (MyClass.class.isAssignableFrom(x.getClass())) { // Noncompliant
MyClass mc = (MyClass)x;
}
----
=== Compliant solution
[source,java]
----
if (x instanceof MyClass.class) {
MyClass mc = (MyClass)x;
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Use "instanceof" instead.
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]