org.springframework.statemachine.trigger

Class TimerTrigger<S,E>

java.lang.Object

org.springframework.statemachine.support.LifecycleObjectSupport

org.springframework.statemachine.trigger.TimerTrigger<S,E>

Type Parameters:

S - the type of state

E - the type of event

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, Trigger<S,E>

public class TimerTrigger<S,E>
extends LifecycleObjectSupport
implements Trigger<S,E>

Implementation of a Trigger capable of firing on a static periods.

Author:

Janne Valkealahti

Constructor Summary

Constructors

Constructor and Description
TimerTrigger(long period) Instantiates a new timer trigger.
TimerTrigger(long period, int count) Instantiates a new timer trigger.

Method Summary

Modifier and Type	Method and Description
void	addTriggerListener(TriggerListener listener) Adds the trigger listener.
void	arm() Arm a trigger.
void	disarm() Disarm a trigger.
protected void	doStart() Subclasses may implement this method with the start behavior.
protected void	doStop() Subclasses may implement this method with the stop behavior.
boolean	evaluate(TriggerContext<S,E> context) Evaluate trigger.
E	getEvent() Gets the event associated with this trigger.

Methods inherited from class org.springframework.statemachine.support.LifecycleObjectSupport

afterPropertiesSet, destroy, doDestroy, getBeanFactory, getPhase, getTaskExecutor, getTaskScheduler, isAutoStartup, isRunning, onInit, setAutoStartup, setBeanFactory, setPhase, setTaskExecutor, setTaskScheduler, start, stop, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

TimerTrigger

public TimerTrigger(long period)

Instantiates a new timer trigger.

Parameters:

period - the period in milliseconds

TimerTrigger

public TimerTrigger(long period,
                    int count)

Instantiates a new timer trigger.

Parameters:

period - the period

count - the count

Method Detail

evaluate

public boolean evaluate(TriggerContext<S,E> context)

Description copied from interface: Trigger

Evaluate trigger.

Specified by:

evaluate in interface Trigger<S,E>

Parameters:

context - the context

Returns:

true, triggers is fired, false otherwise

addTriggerListener

public void addTriggerListener(TriggerListener listener)

Description copied from interface: Trigger

Adds the trigger listener.

Specified by:

addTriggerListener in interface Trigger<S,E>

Parameters:

listener - the listener

getEvent

public E getEvent()

Description copied from interface: Trigger

Gets the event associated with this trigger. It is possible that there are no event association.

Specified by:

getEvent in interface Trigger<S,E>

Returns:

the event

doStart

protected void doStart()

Description copied from class: LifecycleObjectSupport

Subclasses may implement this method with the start behavior. This method will be invoked while holding the LifecycleObjectSupport.lifecycleLock.

Overrides:

doStart in class LifecycleObjectSupport

doStop

protected void doStop()

Description copied from class: LifecycleObjectSupport

Subclasses may implement this method with the stop behavior. This method will be invoked while holding the LifecycleObjectSupport.lifecycleLock.

Overrides:

doStop in class LifecycleObjectSupport

arm

public void arm()

Description copied from interface: Trigger

Arm a trigger. After trigger has been armed a TriggerListener may receive events.

Specified by:

arm in interface Trigger<S,E>

disarm

public void disarm()

Description copied from interface: Trigger

Disarm a trigger. After trigger has been disarmed a TriggerListener will not receive events.

Specified by:

disarm in interface Trigger<S,E>