org.openbase.jul.schedule

Class RecurrenceEventFilter<VALUE>

java.lang.Object

org.openbase.jul.schedule.RecurrenceEventFilter<VALUE>

Type Parameters:

VALUE -

public abstract class RecurrenceEventFilter<VALUE>
extends Object

Author:

Divine Threepwood RecurrenceEventFilter helps to filter high frequency events. After a new incoming event is processed, all further incoming events are skipped except of the last event which is executed after the defined timeout is reached.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_MAX_FREQUENCY
static long	DEFAULT_TEST_TIMEOUT Deprecated.
static long	DEFAULT_TIMEOUT Deprecated.
static long	TEST_MAX_FREQUENCY

Constructor Summary

Constructors

Constructor and Description
RecurrenceEventFilter() Constructor creates a new RecurrenceEventFilter instance pre-configured with the given DEFAULT_MAX_FREQUENCY.
RecurrenceEventFilter(long maxFrequency) Constructor creates a new RecurrenceEventFilter instance pre-configured with the given maxFrequency.

Method Summary

Modifier and Type	Method and Description
void	cancel() Method cancels depending triggers which were not relayed yet.
VALUE	getLastValue() Deprecated. please use getLatestValue() instead.
VALUE	getLatestValue() Method returns the latest triggered value.
boolean	isTriggered() Method returns if this instance was ever triggered since startup or since the last reset.
abstract void	relay() Method should be overwritten to get frequently informed about trigger actions.
void	relay(VALUE value) Method can be overwritten to get frequently informed about trigger actions and the related new value.
void	reset() Method cancels all depending triggers and resets the triggered flag as well as resets the lastValue to null.
void	trigger() This method triggers the relay if no trigger was relayed within the defined max frequency.
void	trigger(boolean immediately) This method triggers the relay if no trigger was relayed within the defined max frequency or the immediately flag was set.
void	trigger(VALUE value) This method triggers the relay if no trigger was relayed within the defined max frequency.
void	trigger(VALUE value, boolean immediately) This method triggers the relay if no trigger was relayed within the defined max frequency or the immediately flag was set.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TIMEOUT

@Deprecated
public static final long DEFAULT_TIMEOUT

Deprecated.

See Also:

Constant Field Values

DEFAULT_MAX_FREQUENCY

public static final long DEFAULT_MAX_FREQUENCY

See Also:

Constant Field Values

DEFAULT_TEST_TIMEOUT

@Deprecated
public static final long DEFAULT_TEST_TIMEOUT

Deprecated.

See Also:

Constant Field Values

TEST_MAX_FREQUENCY

public static final long TEST_MAX_FREQUENCY

See Also:

Constant Field Values

Constructor Detail

RecurrenceEventFilter

public RecurrenceEventFilter()

Constructor creates a new RecurrenceEventFilter instance pre-configured with the given DEFAULT_MAX_FREQUENCY.

RecurrenceEventFilter

public RecurrenceEventFilter(long maxFrequency)

Constructor creates a new RecurrenceEventFilter instance pre-configured with the given maxFrequency.

Parameters:

maxFrequency - this is the maximum frequency in milliseconds where triggered events are relayed.

Method Detail

trigger

public void trigger()
             throws CouldNotPerformException

This method triggers the relay if no trigger was relayed within the defined max frequency. Note: Triggers are maybe filtered but the last trigger call will always result in a relay to guarantee the latest event will relayed.

Throws:

CouldNotPerformException - is thrown if the trigger could not be handled (e.g. because of a system shutdown).

trigger

public void trigger(VALUE value)
             throws CouldNotPerformException

This method triggers the relay if no trigger was relayed within the defined max frequency. Note: Triggers are maybe filtered but the last trigger call will always result in a relay to guarantee the latest value will relayed.

Parameters:

value - the new value which should be published via the next relay.

Throws:

CouldNotPerformException - is thrown if the trigger could not be handled (e.g. because of a system shutdown).

trigger

public void trigger(boolean immediately)
             throws CouldNotPerformException

This method triggers the relay if no trigger was relayed within the defined max frequency or the immediately flag was set. Note: Triggers are maybe filtered but the last trigger call will always result in a relay to guarantee the latest event will relayed.

Parameters:

immediately - this flag forces the trigger to relay immediately without respect to the defined max frequency.

Throws:

CouldNotPerformException - is thrown if the trigger could not be handled (e.g. because of a system shutdown).

trigger

public void trigger(VALUE value,
                    boolean immediately)
             throws CouldNotPerformException

This method triggers the relay if no trigger was relayed within the defined max frequency or the immediately flag was set. Note: Triggers are maybe filtered but the last trigger call will always result in a relay to guarantee the latest value will relayed.

Parameters:

value - the new value which should be published via the next relay.

immediately - this flag forces the trigger to relay immediately without respect to the defined max frequency.

Throws:

CouldNotPerformException - is thrown if the trigger could not be handled (e.g. because of a system shutdown).

cancel

public void cancel()

Method cancels depending triggers which were not relayed yet.

getLastValue

@Deprecated
public VALUE getLastValue()

Deprecated. please use getLatestValue() instead.

Method returns the latest triggered value.

Returns:

the last value or null if no last value is available

getLatestValue

public VALUE getLatestValue()
                     throws NotAvailableException

Method returns the latest triggered value.

Returns:

the latest value.

Throws:

NotAvailableException - is thrown if a value was never triggered.

isTriggered

public boolean isTriggered()

Method returns if this instance was ever triggered since startup or since the last reset.

Returns:

reset

public void reset()

Method cancels all depending triggers and resets the triggered flag as well as resets the lastValue to null.

relay

public void relay(VALUE value)
           throws Exception

Method can be overwritten to get frequently informed about trigger actions and the related new value. Note: Be informed that by overwriting this method the default relay() will not be called anymore.

Parameters:

value - the latest value is passed via this argument.

Throws:

Exception - can be thrown during the relay. The exception will just be printed on the error channel.

relay

public abstract void relay()
                    throws Exception

Method should be overwritten to get frequently informed about trigger actions.

Throws:

Exception - can be thrown during the relay. The exception will just be printed on the error channel.