Package co.paralleluniverse.strands.concurrent

Class AbstractQueuedSynchronizer.ConditionObject

java.lang.Object

co.paralleluniverse.strands.concurrent.AbstractQueuedSynchronizer.ConditionObject

All Implemented Interfaces:

java.io.Serializable, java.util.concurrent.locks.Condition

Enclosing class:

AbstractQueuedSynchronizer

public class AbstractQueuedSynchronizer.ConditionObject
extends java.lang.Object
implements java.util.concurrent.locks.Condition, java.io.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

Constructors

Constructor	Description
ConditionObject()	Creates a new ConditionObject instance.

Method Summary

Modifier and Type	Method	Description
void	await()	Implements interruptible condition wait.
boolean	await(long time, java.util.concurrent.TimeUnit unit)	Implements timed condition wait.
long	awaitNanos(long nanosTimeout)	Implements timed condition wait.
void	awaitUninterruptibly()	Implements uninterruptible condition wait.
boolean	awaitUntil(java.util.Date deadline)	Implements absolute timed condition wait.
protected java.util.Collection<Strand>	getWaitingStrands()	Returns a collection containing those strands that may be waiting on this Condition.
protected int	getWaitQueueLength()	Returns an estimate of the number of strands waiting on this condition.
protected boolean	hasWaiters()	Queries whether any strands are waiting on this condition.
void	signal()	Moves the longest-waiting strand, if one exists, from the wait queue for this condition to the wait queue for the owning lock.
void	signalAll()	Moves all strands from the wait queue for this condition to the wait queue for the owning lock.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConditionObject

public ConditionObject()

Creates a new ConditionObject instance.

Method Detail

signal

public final void signal()

Moves the longest-waiting strand, if one exists, from the wait queue for this condition to the wait queue for the owning lock.

Specified by:

signal in interface java.util.concurrent.locks.Condition

Throws:

java.lang.IllegalMonitorStateException - if AbstractQueuedSynchronizer.isHeldExclusively() returns false

signalAll

public final void signalAll()

Moves all strands from the wait queue for this condition to the wait queue for the owning lock.

Specified by:

signalAll in interface java.util.concurrent.locks.Condition

Throws:

java.lang.IllegalMonitorStateException - if AbstractQueuedSynchronizer.isHeldExclusively() returns false

awaitUninterruptibly

@Suspendable
public final void awaitUninterruptibly()

Implements uninterruptible condition wait.

1. Save lock state returned by AbstractQueuedSynchronizer.getState().
2. Invoke AbstractQueuedSynchronizer.release(int) with saved state as argument, throwing IllegalMonitorStateException if it fails.
3. Block until signalled.
4. Reacquire by invoking specialized version of AbstractQueuedSynchronizer.acquire(int) with saved state as argument.

Specified by:

awaitUninterruptibly in interface java.util.concurrent.locks.Condition

await

@Suspendable
public final void await()
                 throws java.lang.InterruptedException

Implements interruptible condition wait.

1. If current strand is interrupted, throw InterruptedException.
2. Save lock state returned by AbstractQueuedSynchronizer.getState().
3. Invoke AbstractQueuedSynchronizer.release(int) with saved state as argument, throwing IllegalMonitorStateException if it fails.
4. Block until signalled or interrupted.
5. Reacquire by invoking specialized version of AbstractQueuedSynchronizer.acquire(int) with saved state as argument.
6. If interrupted while blocked in step 4, throw InterruptedException.

Specified by:

await in interface java.util.concurrent.locks.Condition

Throws:

java.lang.InterruptedException

awaitNanos

@Suspendable
public final long awaitNanos(long nanosTimeout)
                      throws java.lang.InterruptedException

Implements timed condition wait.

1. If current strand is interrupted, throw InterruptedException.
2. Save lock state returned by AbstractQueuedSynchronizer.getState().
3. Invoke AbstractQueuedSynchronizer.release(int) 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 AbstractQueuedSynchronizer.acquire(int) with saved state as argument.
6. If interrupted while blocked in step 4, throw InterruptedException.

Specified by:

awaitNanos in interface java.util.concurrent.locks.Condition

Throws:

java.lang.InterruptedException

awaitUntil

@Suspendable
public final boolean awaitUntil(java.util.Date deadline)
                         throws java.lang.InterruptedException

Implements absolute timed condition wait.

1. If current strand is interrupted, throw InterruptedException.
2. Save lock state returned by AbstractQueuedSynchronizer.getState().
3. Invoke AbstractQueuedSynchronizer.release(int) 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 AbstractQueuedSynchronizer.acquire(int) 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 java.util.concurrent.locks.Condition

Throws:

java.lang.InterruptedException

await

@Suspendable
public final boolean await(long time,
                           java.util.concurrent.TimeUnit unit)
                    throws java.lang.InterruptedException

Implements timed condition wait.

1. If current strand is interrupted, throw InterruptedException.
2. Save lock state returned by AbstractQueuedSynchronizer.getState().
3. Invoke AbstractQueuedSynchronizer.release(int) 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 AbstractQueuedSynchronizer.acquire(int) 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 java.util.concurrent.locks.Condition

Throws:

java.lang.InterruptedException

hasWaiters

protected final boolean hasWaiters()

Queries whether any strands are waiting on this condition. Implements AbstractQueuedSynchronizer.hasWaiters(ConditionObject).

Returns:

true if there are any waiting strands

Throws:

java.lang.IllegalMonitorStateException - if AbstractQueuedSynchronizer.isHeldExclusively() returns false

getWaitQueueLength

protected final int getWaitQueueLength()

Returns an estimate of the number of strands waiting on this condition. Implements AbstractQueuedSynchronizer.getWaitQueueLength(ConditionObject).

Returns:

the estimated number of waiting strands

Throws:

java.lang.IllegalMonitorStateException - if AbstractQueuedSynchronizer.isHeldExclusively() returns false

getWaitingStrands

protected final java.util.Collection<Strand> getWaitingStrands()

Returns a collection containing those strands that may be waiting on this Condition. Implements AbstractQueuedSynchronizer.getWaitingStrands(ConditionObject).

Returns:

the collection of strands

Throws:

java.lang.IllegalMonitorStateException - if AbstractQueuedSynchronizer.isHeldExclusively() returns false