net.sourceforge.anotherfsm

Interface Processor

All Known Subinterfaces:

Preprocessor, StateMachine

All Known Implementing Classes:

DeterministicStateMachine, EqualsPreprocessor, PreprocessorAdapter, ProcesorGroup, ProcessorAdapter, SearchFsm, SearchFsmProcessor, SearchStringFsm, SearchStringProcessor, SynchronizedStateMachine, ThreadProcessor, TimeoutConnectionFsm, TimeoutConnectionProcessor, TimeoutStateMachine, TypePreprocessor

public interface Processor

Processor of events.

Author:

Michal Turek

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Finish processing of the events and free all allocated resources.
java.lang.String	getName() Get the name of the processor.
Event	process(Event event) Process the event.
void	start() Building of the processor is finished, prepare it to the events processing.

Method Detail

getName

java.lang.String getName()

Get the name of the processor.

Returns:

the name

start

void start()
           throws FsmException

Building of the processor is finished, prepare it to the events processing. It is expected this method is called just once.

Throws:

FsmException

See Also:

close()

close

void close()

Finish processing of the events and free all allocated resources. This method can be called multiple times. Calling methods of the object after its close() should be avoided. The behavior is not defined and may cause unpredictable behavior, e.g. NullPointerException.

See Also:

start()

process

Event process(Event event)
              throws FsmException

Process the event.

Parameters:

event - the input event

Returns:

the processed event

Throws:

FsmException - if something fails