rspec/rules/S4682/java/rule.adoc

57 lines
995 B
Plaintext
Raw Normal View History

== Why is this an issue?
2021-04-28 16:49:39 +02:00
By definition, primitive types are not Objects and so they can't be ``++null++``. Adding ``++@CheckForNull++`` or ``++@Nullable++`` on primitive types adds confusion and is useless.
This rule raises an issue when ``++@CheckForNull++`` or ``++@Nullable++`` is set on a method returning a primitive type: byte, short, int, long, float, double, boolean, char.
=== Noncompliant code example
2021-04-28 16:49:39 +02:00
2022-02-04 17:28:24 +01:00
[source,java]
2021-04-28 16:49:39 +02:00
----
@CheckForNull
boolean isFoo() {
...
}
----
=== Compliant solution
2021-04-28 16:49:39 +02:00
2022-02-04 17:28:24 +01:00
[source,java]
2021-04-28 16:49:39 +02:00
----
boolean isFoo() {
...
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
"XXX" annotation should not be used on primitive types
=== Highlighting
Primitive type
'''
== Comments And Links
(visible only on this page)
=== on 13 Jun 2018, 17:30:29 Alexandre Gigleux wrote:
@CheckForNull = javax.annotation.Nullable
@Nullable = javax.annotation.CheckForNull
endif::env-github,rspecator-view[]