rspec/rules/S3365/java/rule.adoc
Fred Tingaud 16f6c0aecf
Inline adoc when include has no additional value (#1940)
Inline adoc files when they are included exactly once.

Also fix language tags because this inlining gives us better information
on what language the code is written in.
2023-05-25 14:18:12 +02:00

54 lines
823 B
Plaintext

== Why is this an issue?
Once set, the value of a Hibernate ``++@Entity++``'s ``++@Id++`` field/column should never be updated. Therefore, setters for such fields should always be ``++private++``.
=== Noncompliant code example
[source,java]
----
public class Book {
@Id
@GeneratedValue
private int id;
public void setId(int id) { // Noncompliant
this.id = id;
}
----
=== Compliant solution
[source,java]
----
public class Book {
@Id
@GeneratedValue
private int id;
private void setId(int id) {
this.id = id;
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Make this setter "private".
=== Highlighting
* primary: visibility modifier, or method name if ``++protected++``
endif::env-github,rspecator-view[]