Package Summary  Overview Summary

class:AbstractQueuedLongSynchronizer.ConditionObject [NONE]
All Implemented Interfaces:
Serializable, Condition
Enclosing class:
AbstractQueuedLongSynchronizer
public class AbstractQueuedLongSynchronizer.ConditionObjectextends Object implements Condition, Serializable
Condition implementation for a AbstractQueuedLongSynchronizer 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 AbstractQueuedLongSynchronizer.

This class is Serializable, but all fields are transient, so deserialized conditions have no waiters.

See Also:

constructor:AbstractQueuedLongSynchronizer.ConditionObject() [NONE]

  • ConditionObject

    public ConditionObject()
    Creates a new ConditionObject instance.

method:signal() [NONE]

  • 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 interface Condition
    Throws:
    IllegalMonitorStateException - if AbstractQueuedLongSynchronizer.isHeldExclusively() returns false

    • method:signalAll() [NONE]

    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 interface Condition
    Throws:
    IllegalMonitorStateException - if AbstractQueuedLongSynchronizer.isHeldExclusively() returns false

    method:awaitUninterruptibly() [NONE]

    awaitUninterruptibly

    public final  void awaitUninterruptibly()
    Implements uninterruptible condition wait.
    1. Save lock state returned by AbstractQueuedLongSynchronizer.getState().
    2. Invoke AbstractQueuedLongSynchronizer.release(long) with saved state as argument, throwing IllegalMonitorStateException if it fails.
    3. Block until signalled.
    4. Reacquire by invoking specialized version of AbstractQueuedLongSynchronizer.acquire(java.util.concurrent.locks.AbstractQueuedLongSynchronizer.Node, long, boolean, boolean, boolean, long) with saved state as argument.
    Specified by:
    awaitUninterruptibly in interface Condition

    method:await() [NONE]

    await

    public final  void await() throws InterruptedException
    Implements interruptible condition wait.
    1. If current thread is interrupted, throw InterruptedException.
    2. Save lock state returned by AbstractQueuedLongSynchronizer.getState().
    3. Invoke AbstractQueuedLongSynchronizer.release(long) with saved state as argument, throwing IllegalMonitorStateException if it fails.
    4. Block until signalled or interrupted.
    5. Reacquire by invoking specialized version of AbstractQueuedLongSynchronizer.acquire(java.util.concurrent.locks.AbstractQueuedLongSynchronizer.Node, long, boolean, boolean, boolean, long) with saved state as argument.
    6. If interrupted while blocked in step 4, throw InterruptedException.
    Specified by:
    await in interface Condition
    Throws:
    InterruptedException - if the current thread is interrupted (and interruption of thread suspension is supported)

    method:awaitNanos(long) [NONE]

    awaitNanos

    public final  long awaitNanos (long nanosTimeout) throws InterruptedException
    Implements timed condition wait.
    1. If current thread is interrupted, throw InterruptedException.
    2. Save lock state returned by AbstractQueuedLongSynchronizer.getState().
    3. Invoke AbstractQueuedLongSynchronizer.release(long) with saved state as argument, throwing IllegalMonitorStateException if it fails.
    4. Block until signalled, interrupted, or timed out.
    5. Reacquire by invoking specialized version of AbstractQueuedLongSynchronizer.acquire(java.util.concurrent.locks.AbstractQueuedLongSynchronizer.Node, long, boolean, boolean, boolean, long) with saved state as argument.
    6. If interrupted while blocked in step 4, throw InterruptedException.
    Specified by:
    awaitNanos in interface Condition
    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)

    method:awaitUntil(java.util.Date) [NONE]

    awaitUntil

    public final  boolean awaitUntil (Date deadline) throws InterruptedException
    Implements absolute timed condition wait.
    1. If current thread is interrupted, throw InterruptedException.
    2. Save lock state returned by AbstractQueuedLongSynchronizer.getState().
    3. Invoke AbstractQueuedLongSynchronizer.release(long) with saved state as argument, throwing IllegalMonitorStateException if it fails.
    4. Block until signalled, interrupted, or timed out.
    5. Reacquire by invoking specialized version of AbstractQueuedLongSynchronizer.acquire(java.util.concurrent.locks.AbstractQueuedLongSynchronizer.Node, long, boolean, boolean, boolean, long) with saved state as argument.
    6. If interrupted while blocked in step 4, throw InterruptedException.
    7. If timed out while blocked in step 4, return false, else true.
    Specified by:
    awaitUntil in interface Condition
    Parameters:
    deadline - the absolute time to wait until
    Returns:
    false if the deadline has elapsed upon return, else true
    Throws:
    InterruptedException - if the current thread is interrupted (and interruption of thread suspension is supported)

    method:await(long,java.util.concurrent.TimeUnit) [NONE]

    await

    public final  boolean await (long time, TimeUnit unit) throws InterruptedException
    Implements timed condition wait.
    1. If current thread is interrupted, throw InterruptedException.
    2. Save lock state returned by AbstractQueuedLongSynchronizer.getState().
    3. Invoke AbstractQueuedLongSynchronizer.release(long) with saved state as argument, throwing IllegalMonitorStateException if it fails.
    4. Block until signalled, interrupted, or timed out.
    5. Reacquire by invoking specialized version of AbstractQueuedLongSynchronizer.acquire(java.util.concurrent.locks.AbstractQueuedLongSynchronizer.Node, long, boolean, boolean, boolean, long) with saved state as argument.
    6. If interrupted while blocked in step 4, throw InterruptedException.
    7. If timed out while blocked in step 4, return false, else true.
    Specified by:
    await in interface Condition
    Parameters:
    time - the maximum time to wait
    unit - the time unit of the time argument
    Returns:
    false if the waiting time detectably elapsed before return from the method, else true
    Throws:
    InterruptedException - if the current thread is interrupted (and interruption of thread suspension is supported)

    method:hasWaiters() [NONE]

    hasWaiters

    protected final  boolean hasWaiters()
    Queries whether any threads are waiting on this condition. Implements AbstractQueuedLongSynchronizer.hasWaiters(ConditionObject).
    Returns:
    true if there are any waiting threads
    Throws:
    IllegalMonitorStateException - if AbstractQueuedLongSynchronizer.isHeldExclusively() returns false

    method:getWaitQueueLength() [NONE]

    getWaitQueueLength

    protected final  int getWaitQueueLength()
    Returns an estimate of the number of threads waiting on this condition. Implements AbstractQueuedLongSynchronizer.getWaitQueueLength(ConditionObject).
    Returns:
    the estimated number of waiting threads
    Throws:
    IllegalMonitorStateException - if AbstractQueuedLongSynchronizer.isHeldExclusively() returns false

    method:getWaitingThreads() [NONE]

    getWaitingThreads

    protected final  Collection<Thread> getWaitingThreads()
    Returns a collection containing those threads that may be waiting on this Condition. Implements AbstractQueuedLongSynchronizer.getWaitingThreads(ConditionObject).
    Returns:
    the collection of threads
    Throws:
    IllegalMonitorStateException - if AbstractQueuedLongSynchronizer.isHeldExclusively() returns false

    © 2023 Oracle Corporation and/or its affiliates