cz.xtf.core.waiting

Interface Waiter

All Known Implementing Classes:

SimpleWaiter, SupplierWaiter

public interface Waiter

An object that waits on condition to be met.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Waiter.LogPoint Object for configurable conditional logging of waiting.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_INTERVAL

Method Summary

Modifier and Type	Method and Description
default Waiter	failFast(FailFastCheck failFast) Sets waiters fail fast function that indicates (returns true) if there is an error state and waiting should not proceed.
Waiter	interval(long millis) Sets waiter conditions check interval.
Waiter	interval(TimeUnit timeUnit, long t) Sets waiter conditions check interval.
default Waiter	level(org.slf4j.event.Level level) Set the level of severity for a log message.
Waiter	logPoint(Waiter.LogPoint logPoint) Sets waiters logPoints.
default Waiter	onFailure(Runnable runnable) Sets waiters failed awaiting execution.
default Waiter	onIteration(Runnable runnable) Sets waiters execution for each iteration.
default Waiter	onSuccess(Runnable runnable) Sets waiters successful awaiting execution.
default Waiter	onTimeout(Runnable runnable) Sets waiters timed out awaiting execution.
Waiter	reason(String reason) Sets waiting reason.
Waiter	timeout(long millis) Sets waiter timeout after which waiters stops waiting.
Waiter	timeout(TimeUnit timeUnit, long t) Sets waiter timeout after which waiters stops waiting.
boolean	waitFor() Waits till condition is met.

Field Detail

DEFAULT_INTERVAL

static final long DEFAULT_INTERVAL

See Also:

Constant Field Values

Method Detail

timeout

Waiter timeout(long millis)

Sets waiter timeout after which waiters stops waiting. Timeout is logged in case of setting logPoint(LogPoint) to anything else then Waiter.LogPoint.NONE

Parameters:

millis - timeout in milliseconds

Returns:

this

timeout

Waiter timeout(TimeUnit timeUnit,
               long t)

Sets waiter timeout after which waiters stops waiting. Timeout is logged in case of setting logPoint(LogPoint) to anything else then Waiter.LogPoint.NONE

Parameters:

timeUnit - timeUnit that is converts time t to milliseconds

t - timeout in timeUnit

Returns:

this

interval

Waiter interval(long millis)

Sets waiter conditions check interval.

Parameters:

millis - interval in milliseconds

Returns:

this

interval

Waiter interval(TimeUnit timeUnit,
                long t)

Sets waiter conditions check interval.

Parameters:

timeUnit - timeUnit that is converts time t to milliseconds

t - interval in milliseconds

Returns:

this

reason

Waiter reason(String reason)

Sets waiting reason.

Parameters:

reason - what the waiters what upon.

Returns:

this

logPoint

Waiter logPoint(Waiter.LogPoint logPoint)

Sets waiters logPoints.

Parameters:

logPoint - what points of waiting should be logged.

Returns:

this

See Also:

Waiter.LogPoint

level

default Waiter level(org.slf4j.event.Level level)

Set the level of severity for a log message.

Parameters:

level - what level of severity should be used to log the message.

Returns:

this

See Also:

Level

onIteration

default Waiter onIteration(Runnable runnable)

Sets waiters execution for each iteration.

Parameters:

runnable - code to be executed upon successful waiting.

Returns:

this

onSuccess

default Waiter onSuccess(Runnable runnable)

Sets waiters successful awaiting execution.

Parameters:

runnable - code to be executed upon successful waiting.

Returns:

this

onFailure

default Waiter onFailure(Runnable runnable)

Sets waiters failed awaiting execution.

Parameters:

runnable - code to be executed upon failed waiting.

Returns:

this

onTimeout

default Waiter onTimeout(Runnable runnable)

Sets waiters timed out awaiting execution.

Parameters:

runnable - code to be executed upon timed out waiting.

Returns:

this

failFast

default Waiter failFast(FailFastCheck failFast)

Sets waiters fail fast function that indicates (returns true) if there is an error state and waiting should not proceed.

Parameters:

failFast - returns true if waiting has failed.

Returns:

this

waitFor

boolean waitFor()

Waits till condition is met.

Returns:

true if wanted condition was met, false if unwanted state condition was met

Throws:

WaiterException - in case of timeout