com.googlecode.jinahya.util.fsm

Class SwitchTask

java.lang.Object

com.googlecode.jinahya.util.fsm.AbstractTask

com.googlecode.jinahya.util.fsm.SwitchTask

All Implemented Interfaces:

Task

public abstract class SwitchTask
extends AbstractTask

Task for switching conditions.

Author:

Jin Kwon

Constructor Summary

Constructors

Constructor and Description
SwitchTask(java.lang.String id, TransitionMatcher[] onMatchers, TransitionMatcher[] offMatchers) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	matches(Transition transition) Checks if given transition matches to any of matchers.
void	perform(TransitionContext context) Performs desired actions for given transition.
protected abstract void	performOff(TransitionContext context) Performs for switched off.
protected abstract void	performOn(TransitionContext context) Performs for switched on.
void	prepare(TransitionContext context) Prepares for given context.
protected abstract void	prepareOff(TransitionContext context) Prepares to be off.
protected abstract void	prepareOn(TransitionContext context) Prepares to be on.

Methods inherited from class com.googlecode.jinahya.util.fsm.AbstractTask

getId

Methods inherited from class java.lang.Object

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

Constructor Detail

SwitchTask

public SwitchTask(java.lang.String id,
          TransitionMatcher[] onMatchers,
          TransitionMatcher[] offMatchers)

Creates a new instance.

Parameters:

id - task id

onMatchers - matchers for switching on; none null; none empty

offMatchers - matchers for switching off; none null; none empty

Method Detail

matches

public boolean matches(Transition transition)

Description copied from interface: Task

Checks if given transition matches to any of matchers.

Specified by:

matches in interface Task

Overrides:

matches in class AbstractTask

Parameters:

transition - transition to match.

Returns:

true if matches; false otherwise

prepare

public void prepare(TransitionContext context)
             throws FSMException

Description copied from interface: Task

Prepares for given context.

Parameters:

context - transition context

Throws:

FSMException - if an error occurs.

prepareOn

protected abstract void prepareOn(TransitionContext context)
                           throws FSMException

Prepares to be on.

Parameters:

context - transition context

Throws:

FSMException - if an error occurs.

prepareOff

protected abstract void prepareOff(TransitionContext context)
                            throws FSMException

Prepares to be off.

Parameters:

context - transition context

Throws:

FSMException - if an error occurs.

perform

public void perform(TransitionContext context)
             throws FSMException

Description copied from interface: Task

Performs desired actions for given transition.

Parameters:

context - transition context

Throws:

FSMException - if an error occurs.

performOn

protected abstract void performOn(TransitionContext context)
                           throws FSMException

Performs for switched on.

Parameters:

context - transition context

Throws:

FSMException - if an error occurs.

performOff

protected abstract void performOff(TransitionContext context)
                            throws FSMException

Performs for switched off.

Parameters:

context - transition context

Throws:

FSMException - if an error occurs.