Package org.dellroad.stuff.vaadin24.util

Class AsyncTaskStatusChangeEvent<R>

java.lang.Object

java.util.EventObject

org.dellroad.stuff.vaadin24.util.AsyncTaskStatusChangeEvent<R>

Type Parameters:

R - task result type

All Implemented Interfaces:

Serializable

public class AsyncTaskStatusChangeEvent<R>
extends EventObject

Event type emitted by an AsyncTaskManager when an AsyncTask changes status.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CANCELED	Status value indicating that an asynchronous task was cancelTask()'ed (or canceled itself by throwing InterruptedException).
static final int	COMPLETED	Status value indicating that an asynchronous task has completed successfully.
static final int	FAILED	Status value indicating that an asynchronous task failed (i.e., threw an exception).
static final int	STARTED	Status value indicating that a new asynchronous task has started.

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
AsyncTaskStatusChangeEvent(AsyncTaskManager<R> source, long id, int status, R result, Throwable exception)	Constructor.

Method Summary

Modifier and Type	Method	Description
Throwable	getException()	Get the exception thrown by the associated asynchronous task that failed or was canceled.
R	getResult()	Get the result from the successfully completed associated asynchronous task.
AsyncTaskManager<R>	getSource()	Get the AsyncTaskManager that originated this event.
int	getStatus()	Get the new status of the associated asynchronous task: one of STARTED, COMPLETED, CANCELED, or FAILED.
long	getTaskId()	Get the ID of the associated asynchronous task.

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

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

Field Details

STARTED

public static final int STARTED

Status value indicating that a new asynchronous task has started.

See Also:

• Constant Field Values

COMPLETED

public static final int COMPLETED

Status value indicating that an asynchronous task has completed successfully.

See Also:

• Constant Field Values

CANCELED

public static final int CANCELED

Status value indicating that an asynchronous task was cancelTask()'ed (or canceled itself by throwing InterruptedException).

See Also:

• Constant Field Values

FAILED

public static final int FAILED

Status value indicating that an asynchronous task failed (i.e., threw an exception).

See Also:

• Constant Field Values

Constructor Details

AsyncTaskStatusChangeEvent

public AsyncTaskStatusChangeEvent(AsyncTaskManager<R> source,
 long id,
 int status,
 R result,
 Throwable exception)

Constructor.

Parameters:

source - source for this event

id - task unique ID

result - task result, or null if not COMPLETED

exception - thrown exception, or null if not CANCELED or FAILED

Throws:

IllegalArgumentException - if source is null

IllegalArgumentException - if id is zero

IllegalArgumentException - if status is invalid

IllegalArgumentException - if result or exception is inconsistent with status

Method Details

getTaskId

public long getTaskId()

Get the ID of the associated asynchronous task.

Returns:

task ID

getStatus

public int getStatus()

Get the new status of the associated asynchronous task: one of STARTED, COMPLETED, CANCELED, or FAILED.

Returns:

status

getSource

public AsyncTaskManager<R> getSource()

Get the AsyncTaskManager that originated this event.

Overrides:

getSource in class EventObject

Returns:

event originator

getResult

public R getResult()

Get the result from the successfully completed associated asynchronous task.

This method returns null except when the status is COMPLETED, in which case it returns the result of the task.

Returns:

task result, or null if task has not completed successfully

getException

public Throwable getException()

Get the exception thrown by the associated asynchronous task that failed or was canceled.

This method returns null except when the status is FAILED or CANCELED, in which case it returns the exception thrown. In the case of CANCELED, this will always be an InterruptedException.

Returns:

error thrown, or null if task has not yet finished or completed successfully