SimpleWaiter (XTF :: Core 0.23 API)

java.lang.Object
- cz.xtf.core.waiting.SimpleWaiter

All Implemented Interfaces:: Waiter

public class SimpleWaiter
extends Object
implements Waiter

Nested Class Summary
- Nested classes/interfaces inherited from interface cz.xtf.core.waiting.Waiter
  Waiter.LogPoint

Field Summary
- Fields inherited from interface cz.xtf.core.waiting.Waiter
  DEFAULT_INTERVAL

Constructor Summary

Constructors
Constructor and Description
`SimpleWaiter(BooleanSupplier successCondition)`
`SimpleWaiter(BooleanSupplier successCondition, String reason)`
`SimpleWaiter(BooleanSupplier successCondition, TimeUnit timeoutUnit, long timeout)`
`SimpleWaiter(BooleanSupplier successCondition, TimeUnit timeoutUnit, long timeout, String reason)`

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SimpleWaiter
```
public SimpleWaiter(BooleanSupplier successCondition)
```
  - SimpleWaiter
```
public SimpleWaiter(BooleanSupplier successCondition,
                    String reason)
```
  - SimpleWaiter
```
public SimpleWaiter(BooleanSupplier successCondition,
                    TimeUnit timeoutUnit,
                    long timeout)
```
  - SimpleWaiter
```
public SimpleWaiter(BooleanSupplier successCondition,
                    TimeUnit timeoutUnit,
                    long timeout,
                    String reason)
```
- Method Detail
  - failureCondition
```
public SimpleWaiter failureCondition(BooleanSupplier failureCondition)
```
  - timeout
```
public SimpleWaiter timeout(long millis)
```
    Description copied from interface: Waiter
    
    Sets waiter timeout after which waiters stops waiting. Timeout is logged in case of setting Waiter.logPoint(LogPoint) to anything else then Waiter.LogPoint.NONE
    
    Specified by:
    
    timeout in interface Waiter
    
    Parameters:
    
    millis - timeout in milliseconds
    
    Returns:
    
    this
  - timeout
```
public SimpleWaiter timeout(TimeUnit timeUnit,
                            long t)
```
    Description copied from interface: Waiter
    
    Sets waiter timeout after which waiters stops waiting. Timeout is logged in case of setting Waiter.logPoint(LogPoint) to anything else then Waiter.LogPoint.NONE
    
    Specified by:
    
    timeout in interface Waiter
    
    Parameters:
    
    timeUnit - timeUnit that is converts time t to milliseconds
    
    t - timeout in timeUnit
    
    Returns:
    
    this
  - interval
```
public SimpleWaiter interval(long millis)
```
    Description copied from interface: Waiter
    
    Sets waiter conditions check interval.
    
    Specified by:
    
    interval in interface Waiter
    
    Parameters:
    
    millis - interval in milliseconds
    
    Returns:
    
    this
  - interval
```
public SimpleWaiter interval(TimeUnit timeUnit,
                             long t)
```
    Description copied from interface: Waiter
    
    Sets waiter conditions check interval.
    
    Specified by:
    
    interval in interface Waiter
    
    Parameters:
    
    timeUnit - timeUnit that is converts time t to milliseconds
    
    t - interval in milliseconds
    
    Returns:
    
    this
  - reason
```
public SimpleWaiter reason(String reason)
```
    Description copied from interface: Waiter
    
    Sets waiting reason.
    
    Specified by:
    
    reason in interface Waiter
    
    Parameters:
    
    reason - what the waiters what upon.
    
    Returns:
    
    this
  - logPoint
```
public SimpleWaiter logPoint(Waiter.LogPoint logPoint)
```
    Description copied from interface: Waiter
    
    Sets waiters logPoints.
    
    Specified by:
    
    logPoint in interface Waiter
    
    Parameters:
    
    logPoint - what points of waiting should be logged.
    
    Returns:
    
    this
    
    See Also:
    
    Waiter.LogPoint
  - level
```
public SimpleWaiter level(org.slf4j.event.Level level)
```
    Description copied from interface: Waiter
    
    Set the level of severity for a log message.
    
    Specified by:
    
    level in interface Waiter
    
    Parameters:
    
    level - what level of severity should be used to log the message.
    
    Returns:
    
    this
    
    See Also:
    
    Level
  - onIteration
```
public SimpleWaiter onIteration(Runnable runnable)
```
    Description copied from interface: Waiter
    
    Sets waiters execution for each iteration.
    
    Specified by:
    
    onIteration in interface Waiter
    
    Parameters:
    
    runnable - code to be executed upon successful waiting.
    
    Returns:
    
    this
  - onSuccess
```
public SimpleWaiter onSuccess(Runnable runnable)
```
    Description copied from interface: Waiter
    
    Sets waiters successful awaiting execution.
    
    Specified by:
    
    onSuccess in interface Waiter
    
    Parameters:
    
    runnable - code to be executed upon successful waiting.
    
    Returns:
    
    this
  - onFailure
```
public SimpleWaiter onFailure(Runnable runnable)
```
    Description copied from interface: Waiter
    
    Sets waiters failed awaiting execution.
    
    Specified by:
    
    onFailure in interface Waiter
    
    Parameters:
    
    runnable - code to be executed upon failed waiting.
    
    Returns:
    
    this
  - failFast
```
public SimpleWaiter failFast(FailFastCheck failFast)
```
    Description copied from interface: Waiter
    
    Sets waiters fail fast function that indicates (returns true) if there is an error state and waiting should not proceed.
    
    Specified by:
    
    failFast in interface Waiter
    
    Parameters:
    
    failFast - returns true if waiting has failed.
    
    Returns:
    
    this
  - onTimeout
```
public SimpleWaiter onTimeout(Runnable runnable)
```
    Description copied from interface: Waiter
    
    Sets waiters timed out awaiting execution.
    
    Specified by:
    
    onTimeout in interface Waiter
    
    Parameters:
    
    runnable - code to be executed upon timed out waiting.
    
    Returns:
    
    this
  - waitFor
```
public boolean waitFor()
```
    Description copied from interface: Waiter
    
    Waits till condition is met.
    
    Specified by:
    
    waitFor in interface Waiter
    
    Returns:
    
    true if wanted condition was met, false if unwanted state condition was met

Class SimpleWaiter

Nested Class Summary

Nested classes/interfaces inherited from interface cz.xtf.core.waiting.Waiter

Field Summary

Fields inherited from interface cz.xtf.core.waiting.Waiter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SimpleWaiter

SimpleWaiter

SimpleWaiter

SimpleWaiter

Method Detail

failureCondition

timeout

timeout

interval

interval

reason

logPoint

level

onIteration

onSuccess

onFailure

failFast

onTimeout

waitFor