io.atlassian.util.concurrent

Class PhasedLatch

java.lang.Object

io.atlassian.util.concurrent.PhasedLatch

All Implemented Interfaces:

Awaitable, ReusableLatch

@ThreadSafe
public class PhasedLatch
extends Object
implements ReusableLatch

A PhasedLatch is a shared latch that resets after it is released and can be reused. Potentially waiting threads can test the current phase before performing an action. The action is then guarded by that phase and can await that phase to be advanced via a call to release the current phase.

This class is not final but cannot be sub-classed due to the private ctor.

Method Summary

Modifier and Type	Method and Description
void	await() Await the current phase.
boolean	await(long time, TimeUnit unit) Await for the specified time for the condition to become true.
void	awaitPhase(int phase) Await the specified phase.
boolean	awaitPhase(int phase, long period, TimeUnit unit) Await the specified phase for the specified period.
int	getPhase() Get the current phase of the latch.
void	release() Release the current phase.

Methods inherited from class java.lang.Object

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

Method Detail

release

public final void release()

Release the current phase.

Specified by:

release in interface ReusableLatch

await

public final void await()
                 throws InterruptedException

Await the current phase.

Specified by:

await in interface Awaitable

Throws:

InterruptedException - if interrupted

await

public final boolean await(long time,
                           TimeUnit unit)
                    throws InterruptedException

Await for the specified time for the condition to become true. Await the current phase for the specified period.

Specified by:

await in interface Awaitable

Parameters:

time - the amount to wait.

unit - the unit to wait in.

Returns:

true if the condition became true within the time limit, false otherwise.

Throws:

InterruptedException

awaitPhase

public final void awaitPhase(int phase)
                      throws InterruptedException

Await the specified phase.

Parameters:

phase - the phase to wait for

Throws:

InterruptedException - if interrupted

awaitPhase

public final boolean awaitPhase(int phase,
                                long period,
                                TimeUnit unit)
                         throws InterruptedException

Await the specified phase for the specified period.

Parameters:

phase - the phase to wait for

period - the period of time to wait for, as specified by:

unit - of time to measure the period in

Returns:

true if the phase was passed, false otherwise

Throws:

InterruptedException - if interrupted

getPhase

public int getPhase()

Get the current phase of the latch.

Returns:

a int.