org.openbase.jul.schedule

Class Timeout

java.lang.Object

org.openbase.jul.schedule.Timeout

public abstract class Timeout
extends Object

Author:

Divine Threepwood

Constructor Summary

Constructors

Constructor and Description
Timeout(long defaultWaitTime)

Method Summary

Modifier and Type	Method and Description
void	cancel() Method cancels the a started timeout.
abstract void	expired() This method is called in case a timeout is reached.
long	getTimeToWait() Returns the currently configured time to wait until the timeout is reached after start.
boolean	isActive() Return true if the timeout is still running or the expire routine is still executing.
boolean	isExpired() Return true if the given timeout is expired.
void	restart() Method restarts the timeout.
void	restart(long waitTime) Method restarts the timeout.
void	setDefaultWaitTime(long waitTime) Method setup the default time to wait until the timeout is reached.
void	setWaitTime(long waitTime) Deprecated. please use setDefaultWaitTime instead.
void	start() Method starts the timeout.
void	start(long waitTime) Start the timeout with the given wait time.
String	toString() Prints a human readable representation of this timeout.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Timeout

public Timeout(long defaultWaitTime)

Method Detail

getTimeToWait

public long getTimeToWait()

Returns the currently configured time to wait until the timeout is reached after start.

Returns:

the time in milliseconds.

restart

public void restart(long waitTime)
             throws CouldNotPerformException

Method restarts the timeout.

Parameters:

waitTime - the new wait time to update.

Throws:

CouldNotPerformException - is thrown in case the timeout could not be restarted.

restart

public void restart()
             throws CouldNotPerformException

Method restarts the timeout.

Throws:

CouldNotPerformException - is thrown in case the timeout could not be restarted.

isExpired

public boolean isExpired()

Return true if the given timeout is expired.

Returns:

isActive

public boolean isActive()

Return true if the timeout is still running or the expire routine is still executing.

Returns:

start

public void start()
           throws CouldNotPerformException

Method starts the timeout.

Throws:

CouldNotPerformException - is thrown in case the timeout could not be started.

start

public void start(long waitTime)
           throws CouldNotPerformException

Start the timeout with the given wait time. The default wait time is not modified and still the same as before.

Parameters:

waitTime - The time to wait until the timeout is reached.

Throws:

CouldNotPerformException - is thrown in case the timeout could not be started.

cancel

public void cancel()

Method cancels the a started timeout. Node: In case the timeout was never started this method does nothing.

setWaitTime

@Deprecated
public void setWaitTime(long waitTime)

Deprecated. please use setDefaultWaitTime instead.

Parameters:

waitTime -

setDefaultWaitTime

public void setDefaultWaitTime(long waitTime)

Method setup the default time to wait until the timeout is reached.

Parameters:

waitTime - the time to wait in milliseconds.

expired

public abstract void expired()
                      throws InterruptedException

This method is called in case a timeout is reached. This method should be overwritten by a timeout implementation.

Throws:

InterruptedException

toString

public String toString()

Prints a human readable representation of this timeout.

Overrides:

toString in class Object

Returns:

a timeout description as string.