cz.auderis.tools.time.timeout

Class SwitchingTimeout

java.lang.Object

cz.auderis.tools.time.timeout.AbstractBeanBasedTimeout

cz.auderis.tools.time.timeout.SwitchingTimeout

All Implemented Interfaces:

BeanBasedTimeout, ExpirationTrigger, Timeout, Serializable

public class SwitchingTimeout
extends AbstractBeanBasedTimeout

See Also:

Serialized Form

Field Summary

Fields inherited from interface cz.auderis.tools.time.timeout.BeanBasedTimeout

PROPERTY_ELAPSED, PROPERTY_RUNNING, PROPERTY_TIMEOUT

Fields inherited from interface cz.auderis.tools.time.timeout.Timeout

MAX_PERCENT

Constructor Summary

Constructors

Constructor and Description
SwitchingTimeout()

Method Summary

Modifier and Type	Method and Description
SwitchingTimeout	append(Timeout timeout, int repeatCount, boolean removeAfterLastCycle)
void	expireNow() Causes this trigger to expire immediately.
Long	getRemainingMillis() Gets remaining millis.
int	getRemainingPercent() Gets remaining percent.
long	getTimeout() Provides the total timeout time in milliseconds.
boolean	isElapsed() Is elapsed.
boolean	isExpired() Returns information whether this trigger has already expired.
boolean	isRunning() Is running.
SwitchingTimeout	restart() Restart timeout.
boolean	restartIfElapsed() Restart if elapsed.
SwitchingTimeout	setTimeout(long millis) Sets timeout.
SwitchingTimeout	start() Start timeout.
SwitchingTimeout	startIfNotRunning() Start if not running.
SwitchingTimeout	stop() Stop timeout.
String	toString()

Methods inherited from class cz.auderis.tools.time.timeout.AbstractBeanBasedTimeout

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Constructor Detail

SwitchingTimeout

public SwitchingTimeout()

Method Detail

append

public SwitchingTimeout append(Timeout timeout,
                               int repeatCount,
                               boolean removeAfterLastCycle)

getTimeout

public long getTimeout()

Description copied from interface: Timeout

Provides the total timeout time in milliseconds. Notice that this is configurable value, not a remaining time.

Returns:

milliseconds representing total timeout duration

setTimeout

public SwitchingTimeout setTimeout(long millis)

Description copied from interface: Timeout

Sets timeout.

Parameters:

millis - the millis

Returns:

the timeout

start

public SwitchingTimeout start()

Description copied from interface: Timeout

Start timeout.

Returns:

the timeout

startIfNotRunning

public SwitchingTimeout startIfNotRunning()

Description copied from interface: Timeout

Start if not running.

Returns:

the timeout

stop

public SwitchingTimeout stop()

Description copied from interface: Timeout

Stop timeout.

Returns:

the timeout

restart

public SwitchingTimeout restart()

Description copied from interface: Timeout

Restart timeout.

Returns:

the timeout

restartIfElapsed

public boolean restartIfElapsed()

Description copied from interface: Timeout

Restart if elapsed.

Returns:

the boolean

expireNow

public void expireNow()

Description copied from interface: ExpirationTrigger

Causes this trigger to expire immediately.

isRunning

public boolean isRunning()

Description copied from interface: Timeout

Is running.

Returns:

the boolean

isElapsed

public boolean isElapsed()

Description copied from interface: Timeout

Is elapsed.

Returns:

the boolean

isExpired

public boolean isExpired()

Description copied from interface: ExpirationTrigger

Returns information whether this trigger has already expired.

Returns:

true if the trigger is expired

getRemainingPercent

public int getRemainingPercent()

Description copied from interface: Timeout

Gets remaining percent.

Returns:

the remaining percent

getRemainingMillis

public Long getRemainingMillis()

Description copied from interface: Timeout

Gets remaining millis.

Returns:

the remaining millis

toString

public String toString()

Overrides:

toString in class Object