org.osbot.rs07.utility

Class ConditionalSleep

java.lang.Object

org.osbot.rs07.utility.ConditionalSleep

public abstract class ConditionalSleep
extends java.lang.Object

Represents a class that can be used to sleep until a condition evaluates to true.

Constructor Summary

Constructors

Constructor and Description
ConditionalSleep(int timeout) Creates a ConditionalSleep instance that will sleep until its condition is true or if the timeout has expired.
ConditionalSleep(int timeout, int sleepTime) Creates a ConditionalSleep instance that will sleep until its condition is true or if the timeout has expired.
ConditionalSleep(int timeout, int sleepTime, int sleepDeviation) Creates a ConditionalSleep instance that will sleep until its condition is true or if the timeout has expired.
ConditionalSleep(java.lang.Runnable sleepTask, int timeout) Creates a ConditionalSleep instance that will sleep until its condition is true or if the timeout has expired.
ConditionalSleep(java.lang.Runnable sleepTask, int timeout, int sleepTime) Creates a ConditionalSleep instance that will sleep until its condition is true or if the timeout has expired.
ConditionalSleep(java.lang.Runnable sleepTask, int timeout, int sleepTime, int sleepDeviation) Creates a ConditionalSleep instance that will sleep until its condition is true or if the timeout has expired.

Method Summary

Modifier and Type	Method and Description
abstract boolean	condition()
boolean	sleep() Sleeps for as long the specified condition is not true or the timeout has expired.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConditionalSleep

public ConditionalSleep(int timeout)

Creates a ConditionalSleep instance that will sleep until its condition is true or if the timeout has expired. With this constructor the sleep times to check the timeout and condition are centered around 25 milliseconds.

Parameters:

timeout - The specified time out.

ConditionalSleep

public ConditionalSleep(java.lang.Runnable sleepTask,
                        int timeout)

Creates a ConditionalSleep instance that will sleep until its condition is true or if the timeout has expired. With this constructor the sleep times to check the timeout and condition are centered around 25 milliseconds. As long as the condition is not met or the time out has not expired it will perform the given sleep task. Bare in mind that the sleep method will not exit as long as the task is still running, so don't make the sleep task do things that take very long if you want to have fast response times from the sleep method.

Parameters:

sleepTask - The task to perform whilst sleeping.

timeout - The specified time out.

ConditionalSleep

public ConditionalSleep(int timeout,
                        int sleepTime)

Creates a ConditionalSleep instance that will sleep until its condition is true or if the timeout has expired.

Parameters:

timeout - The specified time out.

sleepTime - The time to sleep in milliseconds between timeout and conditions checks.

ConditionalSleep

public ConditionalSleep(int timeout,
                        int sleepTime,
                        int sleepDeviation)

Creates a ConditionalSleep instance that will sleep until its condition is true or if the timeout has expired.

Parameters:

timeout - The specified time out.

sleepTime - The time to sleep in milliseconds between timeout and conditions checks.

sleepDeviation - The normal distribution upper bound and deviation for the sleepTime.

ConditionalSleep

public ConditionalSleep(java.lang.Runnable sleepTask,
                        int timeout,
                        int sleepTime)

Creates a ConditionalSleep instance that will sleep until its condition is true or if the timeout has expired. As long as the condition is not met or the time out has not expired it will perform the given sleep task. Bare in mind that the sleep method will not exit as long as the task is still running, so don't make the sleep task do things that take very long if you want to have fast response times from the sleep method.

Parameters:

sleepTask - The task to perform whilst sleeping.

timeout - The specified time out.

sleepTime - The time to sleep in milliseconds between timeout and conditions checks.

ConditionalSleep

public ConditionalSleep(java.lang.Runnable sleepTask,
                        int timeout,
                        int sleepTime,
                        int sleepDeviation)

Creates a ConditionalSleep instance that will sleep until its condition is true or if the timeout has expired. As long as the condition is not met or the time out has not expired it will perform the given sleep task. Bare in mind that the sleep method will not exit as long as the task is still running, so don't make the sleep task do things that take very long if you want to have fast response times from the sleep method.

Parameters:

sleepTask - The task to perform whilst sleeping.

timeout - The specified time out.

sleepTime - The time to sleep in milliseconds between timeout and conditions checks.

sleepDeviation - The normal distribution upper bound and deviation for the sleepTime.

Method Detail

condition

public abstract boolean condition()
                           throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

sleep

public final boolean sleep()

Sleeps for as long the specified condition is not true or the timeout has expired. If a sleep task is provided with this instance it will perform the task as long as the condition is not met or the time out has not expired. Bare in mind that the sleep method will not exit as long as the task is still running, so don't make the sleep task do things that take very long if you want to have fast response times from this method.

Returns:

True if the condition was met before the timeout expired, false if the time out expired or if an exception was thrown.