com.bonzaiengine.threading

Class Task<T>

java.lang.Object

com.bonzaiengine.threading.Task<T>

All Implemented Interfaces:

java.lang.Comparable<Task<?>>, java.lang.Runnable

Direct Known Subclasses:

Cache.AsyncStream

public abstract class Task<T>
extends java.lang.Object
implements java.lang.Runnable, java.lang.Comparable<Task<?>>

Task queue using a single internal thread for computing datas.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Task.StateChangeListener<T>
static class	Task.TaskState

Constructor Summary

Constructors

Constructor and Description
Task()

Method Summary

Modifier and Type	Method and Description
boolean	addDependency(Task<?> task)
void	addStateChangeListener(Task.StateChangeListener<T> listener)
int	compareTo(Task<?> other)
T	get()
Task<?>[]	getDependencies()
java.lang.Throwable	getException()
int	getPriority()
Task.TaskState	getState()
void	invalidate() Invalidate the task to recompute it
boolean	isComputing()
boolean	isDependenciesReady()
boolean	isReady()
void	onInvalidate()
void	onStateChange(Task.TaskState state)
T	peek()
abstract T	process()
void	removeDependencies() unregister all dependencies task
boolean	removeDependency(Task<?> task)
boolean	removeStateChangeListener(Task.StateChangeListener<T> listener)
void	reset()
void	run()
void	setPriority(int priority)

Methods inherited from class java.lang.Object

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

Constructor Detail

Task

public Task()

Method Detail

compareTo

public int compareTo(Task<?> other)

Specified by:

compareTo in interface java.lang.Comparable<Task<?>>

run

public final void run()

Specified by:

run in interface java.lang.Runnable

invalidate

public void invalidate()

Invalidate the task to recompute it

isReady

public final boolean isReady()

reset

public final void reset()

getState

public final Task.TaskState getState()

Returns:

the state of this Task

isComputing

public final boolean isComputing()

Returns:

true if state is TaskState.Queued or TaskState.Computing

get

public final T get()

Returns:

the result of the state Task.TaskState.Ready

Throws:

java.lang.IllegalStateException - if this Task.TaskState is not Task.TaskState.Ready

peek

public final T peek()

Returns:

the result of this Task computation. It is usually recommended to use get().

Throws:

java.lang.IllegalStateException - if this Task.TaskState is not Task.TaskState.Ready

See Also:

get()

getException

public final java.lang.Throwable getException()

Returns:

the exception of the state Task.TaskState.Failed

Throws:

java.lang.IllegalStateException - if this Task.TaskState is not Task.TaskState.Failed

getPriority

public int getPriority()

Returns:

priority level: 0 default, <0 lower priority, >0 higher priority

setPriority

public final void setPriority(int priority)

onStateChange

public void onStateChange(Task.TaskState state)

addStateChangeListener

public final void addStateChangeListener(Task.StateChangeListener<T> listener)

removeStateChangeListener

public final boolean removeStateChangeListener(Task.StateChangeListener<T> listener)

process

public abstract T process()
                   throws java.lang.Throwable

Throws:

java.lang.Throwable

onInvalidate

public void onInvalidate()

addDependency

public final boolean addDependency(Task<?> task)
                            throws java.lang.IllegalArgumentException

Parameters:

task - register a dependency task

Throws:

java.lang.IllegalArgumentException - if task equals to this

removeDependency

public final boolean removeDependency(Task<?> task)

Parameters:

task - unregister a dependency task

removeDependencies

public final void removeDependencies()

unregister all dependencies task

getDependencies

public final Task<?>[] getDependencies()

Returns:

list of dependencies

isDependenciesReady

public final boolean isDependenciesReady()

Returns:

true if the dependencies are ready