cz.auderis.tools.time.timeout

Interface Timeout

All Superinterfaces:

ExpirationTrigger

All Known Subinterfaces:

BeanBasedTimeout, CountingTimeout

All Known Implementing Classes:

AbstractBeanBasedTimeout, SwitchingTimeout, TimeoutPropertyDecorator

public interface Timeout
extends ExpirationTrigger

Interface Timeout extends the concept of ExpirationTrigger to make tighter relation to the flow of time as the primary cause of expiration triggering.

Version:

1.0

Author:

Boleslav Bobcik <bbobcik@gmail.com>

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_PERCENT The MAX _ pERCENT.

Method Summary

Modifier and Type	Method and Description
Long	getRemainingMillis() Gets remaining millis.
int	getRemainingPercent() Gets remaining percent.
long	getTimeout() Provides the total timeout time in milliseconds.
boolean	isElapsed() Is elapsed.
boolean	isRunning() Is running.
Timeout	restart() Restart timeout.
boolean	restartIfElapsed() Restart if elapsed.
Timeout	setTimeout(long millis) Sets timeout.
Timeout	start() Start timeout.
Timeout	startIfNotRunning() Start if not running.
Timeout	stop() Stop timeout.

Methods inherited from interface cz.auderis.tools.time.timeout.ExpirationTrigger

expireNow, isExpired

Field Detail

MAX_PERCENT

static final int MAX_PERCENT

The MAX _ pERCENT.

See Also:

Constant Field Values

Method Detail

getTimeout

long getTimeout()

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

Returns:

milliseconds representing total timeout duration

setTimeout

Timeout setTimeout(long millis)

Sets timeout.

Parameters:

millis - the millis

Returns:

the timeout

start

Timeout start()

Start timeout.

Returns:

the timeout

startIfNotRunning

Timeout startIfNotRunning()

Start if not running.

Returns:

the timeout

stop

Timeout stop()

Stop timeout.

Returns:

the timeout

restart

Timeout restart()

Restart timeout.

Returns:

the timeout

isRunning

boolean isRunning()

Is running.

Returns:

the boolean

isElapsed

boolean isElapsed()

Is elapsed.

Returns:

the boolean

restartIfElapsed

boolean restartIfElapsed()

Restart if elapsed.

Returns:

the boolean

getRemainingPercent

int getRemainingPercent()

Gets remaining percent.

Returns:

the remaining percent

getRemainingMillis

Long getRemainingMillis()

Gets remaining millis.

Returns:

the remaining millis