rspec/rules/S2444/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

61 lines
1.6 KiB
Plaintext

== Why is this an issue?
In a multi-threaded situation, un-``++synchronized++`` lazy initialization of static fields could mean that a second thread has access to a half-initialized object while the first thread is still creating it. Allowing such access could cause serious bugs. Instead. the initialization block should be ``++synchronized++``.
Similarly, updates of such fields should also be ``++synchronized++``.
This rule raises an issue whenever a lazy static initialization is done on a class with at least one ``++synchronized++`` method, indicating intended usage in multi-threaded applications.
=== Noncompliant code example
[source,java]
----
private static Properties fPreferences = null;
private static Properties getPreferences() {
if (fPreferences == null) {
fPreferences = new Properties(); // Noncompliant
fPreferences.put("loading", "true");
fPreferences.put("filterstack", "true");
readPreferences();
}
return fPreferences;
}
}
----
=== Compliant solution
[source,java]
----
private static Properties fPreferences = null;
private static synchronized Properties getPreferences() {
if (fPreferences == null) {
fPreferences = new Properties();
fPreferences.put("loading", "true");
fPreferences.put("filterstack", "true");
readPreferences();
}
return fPreferences;
}
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Synchronize this lazy initialization of 'xxx'
endif::env-github,rspecator-view[]