Why is this an issue?
An empty method is generally considered bad practice and can lead to confusion, readability, and maintenance issues. Empty methods bring no
functionality and are misleading to others as they might think the method implementation fulfills a specific and identified requirement.
There are several reasons for a method not to have a body:
- It is an unintentional omission, and should be fixed to prevent an unexpected behavior in production.
- It is not yet, or never will be, supported. In this case an exception should be thrown.
- The method is an intentionally-blank override. In this case a nested comment should explain the reason for the blank override.
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()
public abstract class Animal {
void speak() { // default implementation ignored
}
}
How to fix it
Code examples
Noncompliant code example
public void shouldNotBeEmpty() { // Noncompliant - method is empty
}
public void notImplemented() { // Noncompliant - method is empty
}
@Override
public void emptyOnPurpose() { // Noncompliant - method is empty
}
Compliant solution
public void doSomething() {
doSomething();
}
public void notImplemented() {
throw new UnsupportedOperationException("notImplemented() cannot be performed because ...");
}
@Override
public void emptyOnPurpose() {
// comment explaining why the method is empty
}
