rspec/rules/S2273/java/rule.adoc

66 lines
1.2 KiB
Plaintext
Raw Normal View History

2021-04-28 16:49:39 +02:00
By contract, the method ``++Object.wait(...)++``, ``++Object.notify()++`` and ``++Object.notifyAll()++`` should be called by a thread that is the owner of the object's monitor. If this is not the case an ``++IllegalMonitorStateException++`` exception is thrown. This rule reinforces this constraint by making it mandatory to call one of these methods only inside a ``++synchronized++`` method or statement.
2021-04-28 16:49:39 +02:00
== Noncompliant Code Example
2022-02-04 17:28:24 +01:00
[source,java]
2021-04-28 16:49:39 +02:00
----
private void removeElement() {
while (!suitableCondition()){
obj.wait();
}
... // Perform removal
}
----
or
2022-02-04 17:28:24 +01:00
[source,java]
2021-04-28 16:49:39 +02:00
----
private void removeElement() {
while (!suitableCondition()){
wait();
}
... // Perform removal
}
----
2021-04-28 16:49:39 +02:00
== Compliant Solution
2022-02-04 17:28:24 +01:00
[source,java]
2021-04-28 16:49:39 +02:00
----
private void removeElement() {
synchronized(obj) {
while (!suitableCondition()){
obj.wait();
}
... // Perform removal
}
}
----
or
2022-02-04 17:28:24 +01:00
[source,java]
2021-04-28 16:49:39 +02:00
----
private synchronized void removeElement() {
while (!suitableCondition()){
wait();
}
... // Perform removal
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::message.adoc[]
endif::env-github,rspecator-view[]