Module java.base
Package java.util.concurrent.locks
Class AbstractQueuedSynchronizer.ConditionObject
java.lang.Object
java.util.concurrent.locks.AbstractQueuedSynchronizer.ConditionObject
- All Implemented Interfaces:
Serializable
,Condition
- Enclosing class:
- AbstractQueuedSynchronizer
public class AbstractQueuedSynchronizer.ConditionObject extends Object implements Condition, Serializable
Condition implementation for a
AbstractQueuedSynchronizer
serving as the basis of a Lock
implementation.
Method documentation for this class describes mechanics,
not behavioral specifications from the point of view of Lock
and Condition users. Exported versions of this class will in
general need to be accompanied by documentation describing
condition semantics that rely on those of the associated
AbstractQueuedSynchronizer
.
This class is Serializable, but all fields are transient, so deserialized conditions have no waiters.
- See Also:
- Serialized Form
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
await()
Implements interruptible condition wait.boolean
Implements timed condition wait.long
awaitNanos(long nanosTimeout)
Implements timed condition wait.void
Implements uninterruptible condition wait.boolean
awaitUntil(Date deadline)
Implements absolute timed condition wait.protected Collection<Thread>
Returns a collection containing those threads that may be waiting on this Condition.protected int
Returns an estimate of the number of threads waiting on this condition.protected boolean
Queries whether any threads are waiting on this condition.void
signal()
Moves the longest-waiting thread, if one exists, from the wait queue for this condition to the wait queue for the owning lock.void
Moves all threads from the wait queue for this condition to the wait queue for the owning lock.
-
Constructor Details
-
ConditionObject
public ConditionObject()Creates a newConditionObject
instance.
-
-
Method Details
-
signal
public final void signal()Moves the longest-waiting thread, if one exists, from the wait queue for this condition to the wait queue for the owning lock.- Specified by:
signal
in interfaceCondition
- Throws:
IllegalMonitorStateException
- ifAbstractQueuedSynchronizer.isHeldExclusively()
returnsfalse
-
signalAll
public final void signalAll()Moves all threads from the wait queue for this condition to the wait queue for the owning lock.- Specified by:
signalAll
in interfaceCondition
- Throws:
IllegalMonitorStateException
- ifAbstractQueuedSynchronizer.isHeldExclusively()
returnsfalse
-
awaitUninterruptibly
public final void awaitUninterruptibly()Implements uninterruptible condition wait.- Save lock state returned by
AbstractQueuedSynchronizer.getState()
. - Invoke
AbstractQueuedSynchronizer.release(int)
with saved state as argument, throwing IllegalMonitorStateException if it fails. - Block until signalled.
- Reacquire by invoking specialized version of
AbstractQueuedSynchronizer.acquire(java.util.concurrent.locks.AbstractQueuedSynchronizer.Node, int, boolean, boolean, boolean, long)
with saved state as argument.
- Specified by:
awaitUninterruptibly
in interfaceCondition
- Save lock state returned by
-
await
Implements interruptible condition wait.- If current thread is interrupted, throw InterruptedException.
- Save lock state returned by
AbstractQueuedSynchronizer.getState()
. - Invoke
AbstractQueuedSynchronizer.release(int)
with saved state as argument, throwing IllegalMonitorStateException if it fails. - Block until signalled or interrupted.
- Reacquire by invoking specialized version of
AbstractQueuedSynchronizer.acquire(java.util.concurrent.locks.AbstractQueuedSynchronizer.Node, int, boolean, boolean, boolean, long)
with saved state as argument. - If interrupted while blocked in step 4, throw InterruptedException.
- Specified by:
await
in interfaceCondition
- Throws:
InterruptedException
- if the current thread is interrupted (and interruption of thread suspension is supported)
-
awaitNanos
Implements timed condition wait.- If current thread is interrupted, throw InterruptedException.
- Save lock state returned by
AbstractQueuedSynchronizer.getState()
. - Invoke
AbstractQueuedSynchronizer.release(int)
with saved state as argument, throwing IllegalMonitorStateException if it fails. - Block until signalled, interrupted, or timed out.
- Reacquire by invoking specialized version of
AbstractQueuedSynchronizer.acquire(java.util.concurrent.locks.AbstractQueuedSynchronizer.Node, int, boolean, boolean, boolean, long)
with saved state as argument. - If interrupted while blocked in step 4, throw InterruptedException.
- Specified by:
awaitNanos
in interfaceCondition
- Parameters:
nanosTimeout
- the maximum time to wait, in nanoseconds- Returns:
- an estimate of the
nanosTimeout
value minus the time spent waiting upon return from this method. A positive value may be used as the argument to a subsequent call to this method to finish waiting out the desired time. A value less than or equal to zero indicates that no time remains. - Throws:
InterruptedException
- if the current thread is interrupted (and interruption of thread suspension is supported)
-
awaitUntil
Implements absolute timed condition wait.- If current thread is interrupted, throw InterruptedException.
- Save lock state returned by
AbstractQueuedSynchronizer.getState()
. - Invoke
AbstractQueuedSynchronizer.release(int)
with saved state as argument, throwing IllegalMonitorStateException if it fails. - Block until signalled, interrupted, or timed out.
- Reacquire by invoking specialized version of
AbstractQueuedSynchronizer.acquire(java.util.concurrent.locks.AbstractQueuedSynchronizer.Node, int, boolean, boolean, boolean, long)
with saved state as argument. - If interrupted while blocked in step 4, throw InterruptedException.
- If timed out while blocked in step 4, return false, else true.
- Specified by:
awaitUntil
in interfaceCondition
- Parameters:
deadline
- the absolute time to wait until- Returns:
false
if the deadline has elapsed upon return, elsetrue
- Throws:
InterruptedException
- if the current thread is interrupted (and interruption of thread suspension is supported)
-
await
Implements timed condition wait.- If current thread is interrupted, throw InterruptedException.
- Save lock state returned by
AbstractQueuedSynchronizer.getState()
. - Invoke
AbstractQueuedSynchronizer.release(int)
with saved state as argument, throwing IllegalMonitorStateException if it fails. - Block until signalled, interrupted, or timed out.
- Reacquire by invoking specialized version of
AbstractQueuedSynchronizer.acquire(java.util.concurrent.locks.AbstractQueuedSynchronizer.Node, int, boolean, boolean, boolean, long)
with saved state as argument. - If interrupted while blocked in step 4, throw InterruptedException.
- If timed out while blocked in step 4, return false, else true.
- Specified by:
await
in interfaceCondition
- Parameters:
time
- the maximum time to waitunit
- the time unit of thetime
argument- Returns:
false
if the waiting time detectably elapsed before return from the method, elsetrue
- Throws:
InterruptedException
- if the current thread is interrupted (and interruption of thread suspension is supported)
-
hasWaiters
protected final boolean hasWaiters()Queries whether any threads are waiting on this condition. ImplementsAbstractQueuedSynchronizer.hasWaiters(ConditionObject)
.- Returns:
true
if there are any waiting threads- Throws:
IllegalMonitorStateException
- ifAbstractQueuedSynchronizer.isHeldExclusively()
returnsfalse
-
getWaitQueueLength
protected final int getWaitQueueLength()Returns an estimate of the number of threads waiting on this condition. ImplementsAbstractQueuedSynchronizer.getWaitQueueLength(ConditionObject)
.- Returns:
- the estimated number of waiting threads
- Throws:
IllegalMonitorStateException
- ifAbstractQueuedSynchronizer.isHeldExclusively()
returnsfalse
-
getWaitingThreads
Returns a collection containing those threads that may be waiting on this Condition. ImplementsAbstractQueuedSynchronizer.getWaitingThreads(ConditionObject)
.- Returns:
- the collection of threads
- Throws:
IllegalMonitorStateException
- ifAbstractQueuedSynchronizer.isHeldExclusively()
returnsfalse
-