Class FlowControllerMediator

java.lang.Object

ch.nolix.base.programcontrol.flowcontrol.FlowControllerMediator

All Implemented Interfaces:

IFlowControllerMediator

public final class FlowControllerMediator
extends Object
implements IFlowControllerMediator

Author:

Silvan Wyss

Constructor Summary

Constructors

Constructor	Description
FlowControllerMediator()

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.

Methods inherited from class Object

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

Constructor Details

FlowControllerMediator

public FlowControllerMediator()

Method Details

asLongAs

public IAsLongAsMediator asLongAs(BooleanSupplier condition)

Specified by:

asLongAs in interface IFlowControllerMediator

Parameters:

condition -

Returns:

a new IAsLongAsMediator with the given condition.

asSoonAs

public IAsSoonAsMediator asSoonAs(BooleanSupplier condition)

Specified by:

asSoonAs in interface IFlowControllerMediator

Parameters:

condition -

Returns:

a new IAsSoonAsMediator with the given condition.

asSoonAsNoMore

public IAsSoonAsMediator asSoonAsNoMore(BooleanSupplier condition)

Specified by:

asSoonAsNoMore in interface IFlowControllerMediator

Parameters:

condition -

Returns:

a new IAsSoonAsMediator with the negation of the given condition.

enqueue

public IFuture enqueue(Runnable job)

Enqueues the given job.

Specified by:

enqueue in interface IFlowControllerMediator

Parameters:

job -

Returns:

a IFuture for the given job.

forCount

public IForCountMediator forCount(int maxRunCount)

Specified by:

forCount in interface IFlowControllerMediator

Parameters:

maxRunCount -

Returns:

a new IForCountMediator with the given maxRunCount.

forMaxMilliseconds

public IForMaxMillisecondsMediator forMaxMilliseconds(int maxDurationInMilliseconds)

Specified by:

forMaxMilliseconds in interface IFlowControllerMediator

Parameters:

maxDurationInMilliseconds -

Returns:

a new IForMaxMillisecondsMediator for the given maxDurationInMilliseconds.

forMaxSeconds

public IForMaxMillisecondsMediator forMaxSeconds(int maxDurationInSeconds)

Specified by:

forMaxSeconds in interface IFlowControllerMediator

Parameters:

maxDurationInSeconds -

Returns:

a new IForMaxMillisecondsMediator for the given maxDurationInSeconds.

runInBackground

public IFuture runInBackground(Runnable job)

Runs the given job in background.

Specified by:

runInBackground in interface IFlowControllerMediator

Parameters:

job -

Returns:

a new IFuture for the execution of the given job.

runInBackground

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

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

Specified by:

runInBackground in interface IFlowControllerMediator

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.

until

public IAsLongAsMediator until(BooleanSupplier condition)

Specified by:

until in interface IFlowControllerMediator

Parameters:

condition -

Returns:

a new IAsLongAsMediator for the negation of the given condition.

waitAsLongAs

public void waitAsLongAs(BooleanSupplier condition)

Waits as long as the given condition is fulfilled.

Specified by:

waitAsLongAs in interface IFlowControllerMediator

Parameters:

condition -

waitForMilliseconds

public void waitForMilliseconds(int durationInMilliseconds)

Waits for the given durationInMilliseconds.

Specified by:

waitForMilliseconds in interface IFlowControllerMediator

Parameters:

durationInMilliseconds -

waitForSeconds

public void waitForSeconds(int durationInSeconds)

Waits for the given durationInSeconds.

Specified by:

waitForSeconds in interface IFlowControllerMediator

Parameters:

durationInSeconds -

waitUntil

public void waitUntil(BooleanSupplier condition)

Waits until the given condition is fulfilled.

Specified by:

waitUntil in interface IFlowControllerMediator

Parameters:

condition -