jaxx.runtime.swing
Class AbstractActionThread

java.lang.Object
  java.lang.Thread
      jaxx.runtime.swing.AbstractActionThread

All Implemented Interfaces:

Runnable

public abstract class AbstractActionThread
extends Thread

An abstract action thread to consume actions in a non Swing event thread.

Implements the method onActionXXX(ActionWorker) to hook on action status.

To consume an action, use the method addAction(String, Runnable).

TODO Make this multi-action enable

Since:

2.0

Author:

tchemit

Nested Class Summary

static class

AbstractActionThread.ActionWorker Action worker to execute a incoming action.

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

protected AbstractActionThread.ActionWorker	worker current worker to execute action
protected PropertyChangeListener	workerListener the listener of running action

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

protected

AbstractActionThread(String name)

Method Summary

AbstractActionThread.ActionWorker	addAction(String actionLabel, Runnable action) Add an new action to perform.
void	cancel() Cancel the thread, this will release any lock of the tread.
protected void	close() La méthode pour nettoyer le thread, a la fermeture.
Runnable	createRunnable(Object methodContainer, String methodName, Object... arguments) Creates a runnable instance (via a Proxy) to a method given by his name (methodName) to invoke on methodcontainer with given arguments.
protected void	lockThread() To lock the thread.
abstract void	onActionCancel(AbstractActionThread.ActionWorker source) Hook when a action has been canceled.
abstract void	onActionEnd(AbstractActionThread.ActionWorker source) Hook when a action has end with no failure or cancel.
abstract void	onActionFail(AbstractActionThread.ActionWorker source) Hook when a action has failed.
abstract void	onActionStart(AbstractActionThread.ActionWorker source) Hook when a action is about to start.
void	run()
protected void	setWaiting(boolean waiting) Mutates the waiting state of the thread.
protected void	unlockThread() To unlock the thread.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

worker

protected AbstractActionThread.ActionWorker worker

current worker to execute action

workerListener

protected final PropertyChangeListener workerListener

the listener of running action

Constructor Detail

AbstractActionThread

protected AbstractActionThread(String name)

Method Detail

createRunnable

public Runnable createRunnable(Object methodContainer,
                               String methodName,
                               Object... arguments)

Creates a runnable instance (via a Proxy) to a method given by his name (methodName) to invoke on methodcontainer with given arguments.

This is a great feature to create runnable code with a real context.

Parameters:

methodContainer - the container of the method to invoke

methodName - the name of the method to invoke

arguments - parameters to pass to method to invke.

Returns:

the proxy instance

addAction

public AbstractActionThread.ActionWorker addAction(String actionLabel,
                                                   Runnable action)

Add an new action to perform.

Parameters:

actionLabel - the name of the action to perform

action - the action to perform

Returns:

the worker that will launch the action

onActionStart

public abstract void onActionStart(AbstractActionThread.ActionWorker source)

Hook when a action is about to start.

Parameters:

source - the action worker containing the action to perform

onActionFail

public abstract void onActionFail(AbstractActionThread.ActionWorker source)

Hook when a action has failed.

Parameters:

source - the action worker containing the action to perform

onActionCancel

public abstract void onActionCancel(AbstractActionThread.ActionWorker source)

Hook when a action has been canceled.

Parameters:

source - the action worker containing the action to perform

onActionEnd

public abstract void onActionEnd(AbstractActionThread.ActionWorker source)

Hook when a action has end with no failure or cancel.

Parameters:

source - the action worker containing the action to perform

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

cancel

public void cancel()

Cancel the thread, this will release any lock of the tread.

As a side effect, this will close the thread.

close

protected void close()

La méthode pour nettoyer le thread, a la fermeture.

setWaiting

protected void setWaiting(boolean waiting)

Mutates the waiting state of the thread.

If parameter waiting is to true, then will lock the thread, otherwise will unlock the thread.

Parameters:

waiting - true if a lock is required

lockThread

protected void lockThread()
                   throws InterruptedException

To lock the thread.

Throws:

InterruptedException - if locking was interruped

unlockThread

protected void unlockThread()

To unlock the thread.