net.sourceforge.anotherfsm

Class ThreadProcessor

java.lang.Object

net.sourceforge.anotherfsm.ProcessorAdapter

net.sourceforge.anotherfsm.ThreadProcessor

All Implemented Interfaces:

java.lang.Runnable, Processor

public class ThreadProcessor
extends ProcessorAdapter
implements java.lang.Runnable

Processor of events based on a thread with an input queue.

Author:

Michal Turek

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ThreadProcessor.ShutdownEvent Helper event to stop the internal thread on close.

Field Summary

Fields

Modifier and Type	Field and Description
private Processor	processor The internal processor that processes the input events.
private java.util.concurrent.BlockingQueue<Event>	queue The queue for storing of the incoming events before their processing.
private java.lang.Thread	thread The thread for this processor.

Fields inherited from class net.sourceforge.anotherfsm.ProcessorAdapter

logger

Constructor Summary

Constructors

Constructor and Description
ThreadProcessor(Processor processor) Create the object.
ThreadProcessor(Processor processor, boolean daemon, java.util.concurrent.BlockingQueue<Event> queue) Create the object.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Finish processing of the events and free all allocated resources.
(package private) java.lang.String	getThreadName() Helper method to get the name of the internally executed thread.
Event	process(Event event) Process the event.
void	run()
void	start() Building of the processor is finished, prepare it to the events processing.

Methods inherited from class net.sourceforge.anotherfsm.ProcessorAdapter

getName

Methods inherited from class java.lang.Object

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

Field Detail

thread

private final java.lang.Thread thread

The thread for this processor.

queue

private final java.util.concurrent.BlockingQueue<Event> queue

The queue for storing of the incoming events before their processing.

processor

private final Processor processor

The internal processor that processes the input events.

Constructor Detail

ThreadProcessor

public ThreadProcessor(Processor processor,
               boolean daemon,
               java.util.concurrent.BlockingQueue<Event> queue)

Create the object.

Parameters:

processor - the internal processor that process the input events

daemon - the thread is a daemon thread

queue - the queue for storing of the incoming events before their processing

ThreadProcessor

public ThreadProcessor(Processor processor)

Create the object. The thread will be a non-daemon thread and the queue will be LinkedBlockingQueue with unlimited length.

Parameters:

processor - the internal processor that process the input events

Method Detail

getThreadName

java.lang.String getThreadName()

Helper method to get the name of the internally executed thread.

Returns:

the thread 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

Overrides:

start in class ProcessorAdapter

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

Overrides:

close in class ProcessorAdapter

See Also:

Processor.start()

process

public Event process(Event event)
              throws FsmException

Description copied from interface: Processor

Process the event.

Specified by:

process in interface Processor

Parameters:

event - the input event

Returns:

the processed event

Throws:

FsmException - if something fails

run

public void run()

Specified by:

run in interface java.lang.Runnable