cz.auderis.tools.time.timeout

Class TimeoutPropertyDecorator

java.lang.Object

cz.auderis.tools.time.timeout.TimeoutPropertyDecorator

All Implemented Interfaces:

BeanBasedTimeout, ExpirationTrigger, Timeout, Serializable

public class TimeoutPropertyDecorator
extends Object
implements BeanBasedTimeout, Serializable

TimeoutPropertyDecorator

Version:

1.0

Author:

Boleslav Bobcik <bbobcik@gmail.com>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Timeout	delegate
protected AtomicBoolean	lastExpirationState
protected PropertyChangeSupport	propertyChangeSupport

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
TimeoutPropertyDecorator(Timeout delegate)

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener lsnr) Registers property change listener that will monitor all property changes.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener lsnr) Registers property change listener for a specific property
void	checkExpirationChange()
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.
void	removePropertyChangeListener(PropertyChangeListener lsnr) Deregisters a property change listener.
void	removePropertyChangeListener(String propertyName, PropertyChangeListener lsnr)
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 class java.lang.Object

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

Field Detail

delegate

protected final Timeout delegate

propertyChangeSupport

protected PropertyChangeSupport propertyChangeSupport

lastExpirationState

protected AtomicBoolean lastExpirationState

Constructor Detail

TimeoutPropertyDecorator

public TimeoutPropertyDecorator(Timeout delegate)

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener lsnr)

Registers property change listener that will monitor all property changes.

Specified by:

addPropertyChangeListener in interface BeanBasedTimeout

Parameters:

lsnr - property change listener

See Also:

PropertyChangeSupport.addPropertyChangeListener(java.beans.PropertyChangeListener)

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
                                      PropertyChangeListener lsnr)

Registers property change listener for a specific property

Specified by:

addPropertyChangeListener in interface BeanBasedTimeout

Parameters:

propertyName - property to be monitored

lsnr - property change listener

See Also:

PropertyChangeSupport.addPropertyChangeListener(String, java.beans.PropertyChangeListener)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener lsnr)

Deregisters a property change listener.

Specified by:

removePropertyChangeListener in interface BeanBasedTimeout

Parameters:

lsnr - property change listener

See Also:

PropertyChangeSupport.removePropertyChangeListener(java.beans.PropertyChangeListener)

removePropertyChangeListener

public void removePropertyChangeListener(String propertyName,
                                         PropertyChangeListener lsnr)

Specified by:

removePropertyChangeListener in interface BeanBasedTimeout

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.

Specified by:

getTimeout in interface Timeout

Returns:

milliseconds representing total timeout duration

setTimeout

public Timeout setTimeout(long millis)

Description copied from interface: Timeout

Sets timeout.

Specified by:

setTimeout in interface Timeout

Parameters:

millis - the millis

Returns:

the timeout

start

public Timeout start()

Description copied from interface: Timeout

Start timeout.

Specified by:

start in interface Timeout

Returns:

the timeout

startIfNotRunning

public Timeout startIfNotRunning()

Description copied from interface: Timeout

Start if not running.

Specified by:

startIfNotRunning in interface Timeout

Returns:

the timeout

stop

public Timeout stop()

Description copied from interface: Timeout

Stop timeout.

Specified by:

stop in interface Timeout

Returns:

the timeout

restart

public Timeout restart()

Description copied from interface: Timeout

Restart timeout.

Specified by:

restart in interface Timeout

Returns:

the timeout

isRunning

public boolean isRunning()

Description copied from interface: Timeout

Is running.

Specified by:

isRunning in interface Timeout

Returns:

the boolean

isElapsed

public boolean isElapsed()

Description copied from interface: Timeout

Is elapsed.

Specified by:

isElapsed in interface Timeout

Returns:

the boolean

restartIfElapsed

public boolean restartIfElapsed()

Description copied from interface: Timeout

Restart if elapsed.

Specified by:

restartIfElapsed in interface Timeout

Returns:

the boolean

getRemainingPercent

public int getRemainingPercent()

Description copied from interface: Timeout

Gets remaining percent.

Specified by:

getRemainingPercent in interface Timeout

Returns:

the remaining percent

getRemainingMillis

public Long getRemainingMillis()

Description copied from interface: Timeout

Gets remaining millis.

Specified by:

getRemainingMillis in interface Timeout

Returns:

the remaining millis

isExpired

public boolean isExpired()

Description copied from interface: ExpirationTrigger

Returns information whether this trigger has already expired.

Specified by:

isExpired in interface ExpirationTrigger

Returns:

true if the trigger is expired

expireNow

public void expireNow()

Description copied from interface: ExpirationTrigger

Causes this trigger to expire immediately.

Specified by:

expireNow in interface ExpirationTrigger

checkExpirationChange

public void checkExpirationChange()