Interface IFlowControllerMediator

All Known Implementing Classes:

FlowControllerMediator

public interface IFlowControllerMediator

Author:

Silvan Wyss

Method Summary

Modifier and Type	Method	Description
IAsLongAsMediator	asLongAs(BooleanSupplier condition)
IAsSoonAsMediator	asSoonAs(BooleanSupplier condition)
IAsSoonAsMediator	asSoonAsNoMore(BooleanSupplier condition)
IFuture	enqueue(Runnable job)	Enqueues the given job.
IForCountMediator	forCount(int maxRunCount)
IForMaxMillisecondsMediator	forMaxMilliseconds(int maxDurationInMilliseconds)
IForMaxMillisecondsMediator	forMaxSeconds(int maxDurationInSeconds)
IFuture	runInBackground(Runnable job)	Runs the given job in background.
<R> IResultFuture<R>	runInBackground(Supplier<R> resultJob)	Runs the given resultJob in background.
IAsLongAsMediator	until(BooleanSupplier condition)
void	waitAsLongAs(BooleanSupplier condition)	Waits as long as the given condition is fulfilled.
void	waitForMilliseconds(int durationInMilliseconds)	Waits for the given durationInMilliseconds.
void	waitForSeconds(int durationInSeconds)	Waits for the given durationInSeconds.
void	waitUntil(BooleanSupplier condition)	Waits until the given condition is fulfilled.

Method Details

asLongAs

IAsLongAsMediator asLongAs(BooleanSupplier condition)

Parameters:

condition -

Returns:

a new IAsLongAsMediator with the given condition.

Throws:

RuntimeException - if the given condition is null.

asSoonAs

IAsSoonAsMediator asSoonAs(BooleanSupplier condition)

Parameters:

condition -

Returns:

a new IAsSoonAsMediator with the given condition.

Throws:

RuntimeException - if the given condition is null.

asSoonAsNoMore

IAsSoonAsMediator asSoonAsNoMore(BooleanSupplier condition)

Parameters:

condition -

Returns:

a new IAsSoonAsMediator with the negation of the given condition.

Throws:

RuntimeException - if the given condition is null.

enqueue

IFuture enqueue(Runnable job)

Enqueues the given job.

Parameters:

job -

Returns:

a IFuture for the given job.

Throws:

RuntimeException - if the given job is null.

forCount

IForCountMediator forCount(int maxRunCount)

Parameters:

maxRunCount -

Returns:

a new IForCountMediator with the given maxRunCount.

Throws:

RuntimeException - if the given maxRunCount is negative.

forMaxMilliseconds

IForMaxMillisecondsMediator forMaxMilliseconds(int maxDurationInMilliseconds)

Parameters:

maxDurationInMilliseconds -

Returns:

a new IForMaxMillisecondsMediator for the given maxDurationInMilliseconds.

Throws:

RuntimeException - if the given maxDurationInMilliseconds is negative.

forMaxSeconds

IForMaxMillisecondsMediator forMaxSeconds(int maxDurationInSeconds)

Parameters:

maxDurationInSeconds -

Returns:

a new IForMaxMillisecondsMediator for the given maxDurationInSeconds.

Throws:

RuntimeException - if the given maxDurationInSeconds is negative.

runInBackground

IFuture runInBackground(Runnable job)

Runs the given job in background.

Parameters:

job -

Returns:

a new IFuture for the execution of the given job.

Throws:

RuntimeException - if the given job is null.

runInBackground

<R> IResultFuture<R> runInBackground(Supplier<R> resultJob)

Runs the given resultJob in background. A result job is a job that returns a result.

Type Parameters:

R - is the type of the result the given resultJob returns.

Parameters:

resultJob -

Returns:

a new IResultFuture for the execution of the given resultJob.

Throws:

RuntimeException - if the given resultJob is null.

until

IAsLongAsMediator until(BooleanSupplier condition)

Parameters:

condition -

Returns:

a new IAsLongAsMediator for the negation of the given condition.

Throws:

RuntimeException - if the given condition is null.

waitAsLongAs

void waitAsLongAs(BooleanSupplier condition)

Waits as long as the given condition is fulfilled.

Parameters:

condition -

Throws:

RuntimeException - if the given condition is null.

waitForMilliseconds

void waitForMilliseconds(int durationInMilliseconds)

Waits for the given durationInMilliseconds.

Parameters:

durationInMilliseconds -

Throws:

RuntimeException - if the given durationInMilliseconds is negative.

waitForSeconds

void waitForSeconds(int durationInSeconds)

Waits for the given durationInSeconds.

Parameters:

durationInSeconds -

Throws:

RuntimeException - if the given durationInSeconds is negative.

waitUntil

void waitUntil(BooleanSupplier condition)

Waits until the given condition is fulfilled.

Parameters:

condition -

Throws:

RuntimeException - if the given condition is null.