rspec/rules/S1186/java/rule.adoc

65 lines
1.4 KiB
Plaintext
Raw Normal View History

2020-06-30 12:47:33 +02:00
There are several reasons for a method not to have a method body:
2021-02-02 15:02:10 +01:00
2020-06-30 12:47:33 +02:00
* It is an unintentional omission, and should be fixed to prevent an unexpected behavior in production.
2021-01-27 13:42:22 +01:00
* It is not yet, or never will be, supported. In this case an ``++UnsupportedOperationException++`` should be thrown.
2020-06-30 12:47:33 +02:00
* The method is an intentionally-blank override. In this case a nested comment should explain the reason for the blank override.
== Noncompliant Code Example
2022-02-04 17:28:24 +01:00
[source,java]
2020-06-30 12:47:33 +02:00
----
public void doSomething() {
}
public void doSomethingElse() {
}
----
== Compliant Solution
2022-02-04 17:28:24 +01:00
[source,java]
2020-06-30 12:47:33 +02:00
----
@Override
public void doSomething() {
// Do nothing because of X and Y.
}
@Override
public void doSomethingElse() {
throw new UnsupportedOperationException();
}
----
== Exceptions
This does not raise an issue in the following cases:
* Non-public default (no-argument) constructors
* Public default (no-argument) constructors when there are other constructors in the class
* Empty methods in abstract classes
* Methods annotated with `@org.aspectj.lang.annotation.Pointcut()`
2020-06-30 12:47:33 +02:00
2021-02-02 15:02:10 +01:00
2020-06-30 12:47:33 +02:00
----
public abstract class Animal {
void speak() { // default implementation ignored
}
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]