mirror of
https://github.com/github/codeql.git
synced 2026-04-09 00:54:00 +02:00
e21cbe82a9
Where possible update Java documentation links to Java 11. Additionally update some other links to use HTTPS.
36 lines
1.1 KiB
XML
36 lines
1.1 KiB
XML
<!DOCTYPE qhelp PUBLIC
|
|
"-//Semmle//qhelp//EN"
|
|
"qhelp.dtd">
|
|
<qhelp>
|
|
|
|
|
|
<overview>
|
|
<p>A field of immutable type that is not declared <code>final</code>, but is assigned to only in a
|
|
constructor or static initializer of its declaring type, may lead to defects and makes code less
|
|
readable. This is because other parts of the code may be based on the assumption that the field has
|
|
a constant value, and a later modification, which includes an assignment to the field, may
|
|
invalidate this assumption.
|
|
</p>
|
|
|
|
</overview>
|
|
<recommendation>
|
|
|
|
<p>If a field of immutable type is assigned to only during class or instance initialization,
|
|
you should usually declare it <code>final</code>. This forces the compiler to verify that the field
|
|
value cannot be changed subsequently, which can help to avoid defects and increase code readability.
|
|
</p>
|
|
|
|
</recommendation>
|
|
<references>
|
|
|
|
|
|
<li>
|
|
Java Language Specification:
|
|
<a href="https://docs.oracle.com/javase/specs/jls/se11/html/jls-4.html#jls-4.12.4">4.12.4 final Variables</a>,
|
|
<a href="https://docs.oracle.com/javase/specs/jls/se11/html/jls-8.html#jls-8.3.1.2">8.3.1.2 final Fields</a>.
|
|
</li>
|
|
|
|
|
|
</references>
|
|
</qhelp>
|