net.eduvax.util

Class AObservableRunnable

java.lang.Object

net.eduvax.util.AObservableRunnable

All Implemented Interfaces:

java.lang.Runnable, Observable<AObservableRunnable>

public abstract class AObservableRunnable
extends java.lang.Object
implements java.lang.Runnable, Observable<AObservableRunnable>

Observable Runnable.

Let an obser to be notified on runnable state change from READY, RUNNING, ENDED or EXCEPTION.

warning: subclasses must implement oRun() method instead of run() as for regular runnables. This class provide a default run() implatation to manage state transitions and observers notifications.

See Also:

observer registration and deregistration rules., observer implementation rules.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AObservableRunnable.EState Available runnable states identifications.

Field Summary

Fields

Modifier and Type	Field and Description
private ErrorHandler	_errHandler error handler
private java.lang.Exception	_exception uncatch exception.
private ObserverManager<AObservableRunnable>	_obsManager Observers manager.
private AObservableRunnable.EState	_state current state.

Constructor Summary

Constructors

Constructor and Description
AObservableRunnable() Create new observable runnable.

Method Summary

Methods

Modifier and Type	Method and Description
protected ErrorHandler	getErrHandler()
java.lang.Exception	getException() Uncatched exception.
ObserverManager<AObservableRunnable>	getObserverManager() Get this observable observer registration manager.
AObservableRunnable.EState	getState() Get current state.
abstract void	oRun() Observable runnable entry point.
void	run() Runnable implementation.
void	setErrorHandler(ErrorHandler eh) Change error handler.

Methods inherited from class java.lang.Object

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

Field Detail

_exception

private java.lang.Exception _exception

uncatch exception. Stay null unless there is any.

_state

private AObservableRunnable.EState _state

current state. Any if READY, RUNNING, ENDED, EXCEPTION

_obsManager

private ObserverManager<AObservableRunnable> _obsManager

Observers manager.

_errHandler

private ErrorHandler _errHandler

error handler

Constructor Detail

AObservableRunnable

public AObservableRunnable()

Create new observable runnable. Default error handler is App's default error handler. Use setErrHandler to provide alternate error handling, before running the runnable.

Method Detail

oRun

public abstract void oRun()

Observable runnable entry point.

run

public void run()

Runnable implementation. warning: don't override this method to keep state management and notification implemented here. Override oRun().

Specified by:

run in interface java.lang.Runnable

getException

public java.lang.Exception getException()

Uncatched exception.

Returns:

when state is EXCEPTION, the uncatched exception cause of the running failure. Otherwise null.

getState

public AObservableRunnable.EState getState()

Get current state.

Returns:

- EState.READY : not yet started.
- EState.RUNNING : started, running in progress.
- EState.ENDED : running done without exception (errors may have been reported to error handler).
- EState.EXCEPTION : running interrupted by uncatched exception. It is available using getException().
warning: state may change as soon it is returned if this method is called outside the thread running the run() method. Observers should not suffer this from their observableChanged() implementation that is invoked from the thread running the run() method.

getObserverManager

public ObserverManager<AObservableRunnable> getObserverManager()

Description copied from interface: Observable

Get this observable observer registration manager.

Specified by:

getObserverManager in interface Observable<AObservableRunnable>

Returns:

Observer manager.

getErrHandler

protected ErrorHandler getErrHandler()

Returns:

error handler.

setErrorHandler

public void setErrorHandler(ErrorHandler eh)

Change error handler. Error handler should be defined before running the runnable. If not so, new error handler may miss some errors.

Parameters:

eh - new error handler.