rspec/rules/S6207/java/rule.adoc
2022-02-04 16:28:24 +00:00

69 lines
1.7 KiB
Plaintext

In Java 16 records represent a brief notation for immutable data structures. Records have autogenerated implementations for constructors with all parameters, ``++getters++``, ``++equals++``, ``++hashcode++`` and ``++toString++``. Although these methods can still be overridden inside records, there is no use to do so if no special logic is required.
This rule reports an issue on empty compact constructors, trivial canonical constructors and simple getter methods with no additional logic.
== Noncompliant Code Example
[source,java]
----
record Person(String name, int age) {
Person(String name, int age) { // Noncompliant, already autogenerated
this.name = name;
this.age = age;
}
}
record Person(String name, int age) {
Person { // Noncompliant, no need for empty compact constructor
}
public String name() { // Noncompliant, already autogenerated
return name;
}
}
----
== Compliant Solution
[source,java]
----
record Person(String name, int age) { } // Compliant
record Person(String name, int age) {
Person(String name, int age) { // Compliant
this.name = name.toLowerCase(Locale.ROOT);
this.age = age;
}
}
record Person(String name, int age) {
Person { // Compliant
if (age < 0) {
throw new IllegalArgumentException("Negative age");
}
}
public String name() { // Compliant
return name.toUpperCase(Locale.ROOT);
}
}
----
== See
* https://docs.oracle.com/javase/specs/jls/se16/html/jls-8.html#jls-8.10[Records specification]
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::message.adoc[]
include::highlighting.adoc[]
endif::env-github,rspecator-view[]