Package io.github.thecsdev.tcdcommons.api.util.thread

Class ProgressiveTask<T>

java.lang.Object

io.github.thecsdev.tcdcommons.api.util.thread.ProgressiveTask<T>

Type Parameters:

T - The type of the result that is produced by this ProgressiveTask.

Direct Known Subclasses:

DescriptiveProgressiveTask

public abstract class ProgressiveTask<T>
extends Object

Represents a task that is happening or developing gradually or in stages.
The task is executed asynchronously, and its progress is tracked.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ProgressiveTask.PtFinished
static interface	ProgressiveTask.PtPc

Field Summary

Fields

Modifier and Type	Field	Description
final TEvent<ProgressiveTask.PtFinished>	eFinished	A TEvent that is invoked when this ProgressiveTask finishes its execution in executeSync().
final TEvent<ProgressiveTask.PtPc>	eProgressChanged	A TEvent that is invoked when setProgress(float) is called.

Constructor Summary

Constructors

Constructor	Description
ProgressiveTask()

Method Summary

Modifier and Type	Method	Description
final void	clearFlags()	Clears all flags associated with this ProgressiveTask, making it look as if it were never executed before.
final void	executeSync()	Synchronously executes this ProgressiveTask.
final @Nullable Throwable	getError()	If the task execution fails due a raised Throwable, there will be no getResult(), and instead, there will be a Throwable returned by getError().
final float	getProgress()	Retrieves the current progress of this ProgressiveTask's execution.
final T	getResult()	Returns the result of this ProgressiveTask.
final boolean	isFinished()	Returns true if this ProgressiveTask has finished executing.
final boolean	isRunning()	Returns true if this ProgressiveTask is currently executing.
protected abstract T	onExecuteTask()	The main logic responsible for executing this ProgressiveTask. This is where the task's main code goes.
protected final void	setProgress(float progress)	Sets this ProgressiveTask's current "progress" value.

Methods inherited from class java.lang.Object

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

Field Details

eProgressChanged

public final TEvent<ProgressiveTask.PtPc> eProgressChanged

A TEvent that is invoked when setProgress(float) is called.

eFinished

public final TEvent<ProgressiveTask.PtFinished> eFinished

A TEvent that is invoked when this ProgressiveTask finishes its execution in executeSync().

Constructor Details

ProgressiveTask

public ProgressiveTask()

Method Details

getProgress

public final float getProgress()

Retrieves the current progress of this ProgressiveTask's execution.

See Also:

• isRunning()
• isFinished()

setProgress

protected final void setProgress(float progress)

Sets this ProgressiveTask's current "progress" value. Used by onExecuteTask() to indicate the current execution progress.

Parameters:

progress - The 0-1 value indicating this task's current execution progress.

isRunning

public final boolean isRunning()

Returns true if this ProgressiveTask is currently executing.

isFinished

public final boolean isFinished()

Returns true if this ProgressiveTask has finished executing.

getResult

@Nullable
public final T getResult()

Returns the result of this ProgressiveTask.

See Also:

• getError()

getError

@Nullable
public final @Nullable Throwable getError()

If the task execution fails due a raised Throwable, there will be no getResult(), and instead, there will be a Throwable returned by getError().

See Also:

• getResult()

clearFlags

public final void clearFlags()
                      throws IllegalStateException

Clears all flags associated with this ProgressiveTask, making it look as if it were never executed before.

Throws:

IllegalStateException - If the task is currently running.

See Also:

• isRunning()

executeSync

public final void executeSync()

Synchronously executes this ProgressiveTask.

onExecuteTask

@Nullable
protected abstract T onExecuteTask()
                            throws Exception

The main logic responsible for executing this ProgressiveTask.
This is where the task's main code goes.

Returns:

The result of this ProgressiveTask that is then obtained via getResult().

Throws:

Exception