org.jasig.portal.utils.threading
Class BaseTask

java.lang.Object
  org.jasig.portal.utils.threading.BaseTask

All Implemented Interfaces:

Runnable, Task

Direct Known Subclasses:

ChannelRenderer.Worker, RunnableTask

public abstract class BaseTask
extends Object
implements Task

A convenience base task class for subclasses. Introduces an execute() method which declares throws Exception, which subclasses may override. Any Exception thrown from execute will be caught and stored, to be accessible through getException NOTE: Throwable is not caught to avoid catching Errors

Author:

Aaron Hamid (arh14 at cornell dot edu)

Field Summary

protected Exception

exception

Constructor Summary

BaseTask()

Method Summary

abstract void	execute() Subclasses should implement this method NOTE: not declaring throws Throwable.
Exception	getException() Returns the exception that was thrown during execution, if any
void	run() Run implementation which delegates to execute().
protected void	setException(Exception e) Only subclasses are allowed to use this

Methods inherited from class java.lang.Object

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

Field Detail

exception

protected Exception exception

Constructor Detail

BaseTask

public BaseTask()

Method Detail

run

public void run()

Run implementation which delegates to execute(). Catches and stores any exception execute() throws.

Specified by:

run in interface Runnable

See Also:

execute()

setException

protected void setException(Exception e)

Only subclasses are allowed to use this

Parameters:

e - exception to set

execute

public abstract void execute()
                      throws Exception

Subclasses should implement this method NOTE: not declaring throws Throwable. We shouldn't really catch Errors, should we?

Throws:

Exception

getException

public Exception getException()

Returns the exception that was thrown during execution, if any

Specified by:

getException in interface Task

Returns:

the exception that was thrown during execution, if any