net.sourceforge.anotherfsm

Class EqualsPreprocessor

java.lang.Object

net.sourceforge.anotherfsm.EqualsPreprocessor

All Implemented Interfaces:

Preprocessor, Processor

public class EqualsPreprocessor
extends java.lang.Object

Processors of the events based on equals method. The object can be used in multithreaded environment. Building of the object is NOT synchronized and should be done just in one thread. Only the processing of the events is thread safe.

Author:

Michal Turek

Nested Class Summary

Nested classes/interfaces inherited from interface net.sourceforge.anotherfsm.Preprocessor

Preprocessor.Processor<T extends Event>

Field Summary

Fields

Modifier and Type	Field and Description
protected FsmLogger	logger The logger.

Constructor Summary

Constructors

Constructor and Description
EqualsPreprocessor(java.lang.String name) Create the object.

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Event> void	addProcessor(T event, Preprocessor.Processor<T> processor) Add a new processor.
void	close() Finish processing of the events and free all allocated resources.
protected Preprocessor.Processor	findProcessor(Event event) Find appropriate processor for an event.
java.lang.String	getName() Get the name of the processor.
Event	process(Event event) Process or preprocess the event.
void	start() Building of the processor is finished, prepare it to the events processing.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.anotherfsm.Processor

close, getName, start

Field Detail

logger

protected final FsmLogger logger

The logger.

Constructor Detail

EqualsPreprocessor

public EqualsPreprocessor(java.lang.String name)

Create the object.

Parameters:

name - the name of the event processor

Method Detail

addProcessor

public <T extends Event> void addProcessor(T event,
                                  Preprocessor.Processor<T> processor)
                  throws FsmException

Add a new processor. The method is not thread safe.

Parameters:

event - the event

processor - the processor

Throws:

FsmException - if the processor is already defined

findProcessor

protected Preprocessor.Processor findProcessor(Event event)

Find appropriate processor for an event.

Parameters:

event - the event

Returns:

the processor or null if the processor was not found

process

public Event process(Event event)
              throws FsmException

Description copied from interface: Preprocessor

Process or preprocess the event.

Specified by:

process in interface Preprocessor

Specified by:

process in interface Processor

Parameters:

event - the input event, a newly generated event or NullEvent to ignore the event

Returns:

the processed event

Throws:

FsmException - if something fails

See Also:

NullEvent

getName

public java.lang.String getName()

Description copied from interface: Processor

Get the name of the processor.

Specified by:

getName in interface Processor

Returns:

the name

start

public void start()
           throws FsmException

Description copied from interface: Processor

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

Specified by:

start in interface Processor

Throws:

FsmException

See Also:

Processor.close()

close

public void close()

Description copied from interface: Processor

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

Specified by:

close in interface Processor

See Also:

Processor.start()