Package com.pervasivecode.utils.concurrent.testing

Class PausingAwaitableNoOpRunnable

java.lang.Object

com.pervasivecode.utils.concurrent.testing.PausingAwaitableNoOpRunnable

All Implemented Interfaces:

AwaitableRunnable, PausingRunnable, Runnable

public final class PausingAwaitableNoOpRunnable
extends Object
implements AwaitableRunnable, PausingRunnable

A simple Runnable that pauses until released, and which provides a means of waiting until it has finished executing and determining if it has already finished.

See Also:

AwaitableNoOpRunnable, PausingNoOpRunnable

Constructor Summary

Constructors

Constructor	Description
PausingAwaitableNoOpRunnable()

Method Summary

Modifier and Type	Method	Description
void	awaitTaskCompletion()	Block until the task has finished running.
boolean	awaitTaskCompletion(long amount, TimeUnit unit)	Block until the task has finished running, or until a timeout has expired.
boolean	equals(Object other)
int	hashCode()
boolean	hasPaused()	Has the PausingRunnable paused yet? If it has been unpaused this will also return true.
boolean	hasTaskFinished()	Has the task finished?
boolean	hasUnpaused()	Has the PausingRunnable been paused and then unpaused?
void	run()
void	unpause()	Release a paused PausingRunnable so that it can continue running.
void	waitUntilPaused()	Block the current thread indefinitely, until the PausingRunnable is paused.
boolean	waitUntilPaused(long amount, TimeUnit unit)	Block the current thread until the PausingRunnable is paused, unless a timeout has expired while waiting.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PausingAwaitableNoOpRunnable

public PausingAwaitableNoOpRunnable()

Method Detail

run

public void run()

Specified by:

run in interface Runnable

hasTaskFinished

public boolean hasTaskFinished()

Description copied from interface: AwaitableRunnable

Has the task finished?

Specified by:

hasTaskFinished in interface AwaitableRunnable

Returns:

True if the task has finished.

awaitTaskCompletion

public void awaitTaskCompletion()
                         throws InterruptedException

Description copied from interface: AwaitableRunnable

Block until the task has finished running.

Specified by:

awaitTaskCompletion in interface AwaitableRunnable

Throws:

InterruptedException - If the thread was interrupted while waiting.

awaitTaskCompletion

public boolean awaitTaskCompletion(long amount,
                                   TimeUnit unit)
                            throws InterruptedException

Description copied from interface: AwaitableRunnable

Block until the task has finished running, or until a timeout has expired.

Specified by:

awaitTaskCompletion in interface AwaitableRunnable

Parameters:

amount - The duration of the timeout.

unit - The units of the amount parameter.

Returns:

True if the task completed before the timeout expired; false if it did not.

Throws:

InterruptedException - If the thread was interrupted while waiting.

hasPaused

public boolean hasPaused()

Description copied from interface: PausingRunnable

Has the PausingRunnable paused yet? If it has been unpaused this will also return true.

Specified by:

hasPaused in interface PausingRunnable

Returns:

true if it is paused, or was previously paused and has been unpaused.

waitUntilPaused

public void waitUntilPaused()
                     throws InterruptedException

Description copied from interface: PausingRunnable

Block the current thread indefinitely, until the PausingRunnable is paused.

Specified by:

waitUntilPaused in interface PausingRunnable

Throws:

InterruptedException - if the thread that is waiting is interrupted.

waitUntilPaused

public boolean waitUntilPaused(long amount,
                               TimeUnit unit)
                        throws InterruptedException

Description copied from interface: PausingRunnable

Block the current thread until the PausingRunnable is paused, unless a timeout has expired while waiting. If the timeout expires, this method will return false.

Specified by:

waitUntilPaused in interface PausingRunnable

Parameters:

amount - The magnitude of the timeout value.

unit - The units of the timeout value.

Returns:

true if the PausingRunnable paused before the timeout expired, or false if the timeout expired before the PausingRunnable paused.

Throws:

InterruptedException - if the thread that is waiting is interrupted.

unpause

public void unpause()

Description copied from interface: PausingRunnable

Release a paused PausingRunnable so that it can continue running.

Specified by:

unpause in interface PausingRunnable

hasUnpaused

public boolean hasUnpaused()

Description copied from interface: PausingRunnable

Has the PausingRunnable been paused and then unpaused?

Specified by:

hasUnpaused in interface PausingRunnable

Returns:

true if it has been unpaused.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object