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

Class DescriptiveProgressiveTask<T>

java.lang.Object

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

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

public abstract class DescriptiveProgressiveTask<T>
extends ProgressiveTask<T>

A ProgressiveTask that also provides descriptions on "what is currently happening as the task is executing".

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescriptiveProgressiveTask.DptPdc

Nested classes/interfaces inherited from class io.github.thecsdev.tcdcommons.api.util.thread.ProgressiveTask

ProgressiveTask.PtFinished, ProgressiveTask.PtPc

Field Summary

Fields

Modifier and Type	Field	Description
final TEvent<DescriptiveProgressiveTask.DptPdc>	eProgressDescriptionChanged	A TEvent that is invoked whenever setProgressDescription(Text) is called.

Fields inherited from class io.github.thecsdev.tcdcommons.api.util.thread.ProgressiveTask

eFinished, eProgressChanged

Constructor Summary

Constructors

Constructor	Description
DescriptiveProgressiveTask()

Method Summary

Modifier and Type	Method	Description
final @Nullable net.minecraft.text.Text	getProgressDescription()	Returns a user-friendly Text that describes what is currently going on as the task is executing.
protected final void	setProgressDescription(@Nullable net.minecraft.text.Text description)	Sets the user-friendly Text that describes what is currently going on as the task is executing.

Methods inherited from class io.github.thecsdev.tcdcommons.api.util.thread.ProgressiveTask

clearFlags, executeSync, getError, getProgress, getResult, isFinished, isRunning, onExecuteTask, setProgress

Methods inherited from class java.lang.Object

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

Field Details

eProgressDescriptionChanged

public final TEvent<DescriptiveProgressiveTask.DptPdc> eProgressDescriptionChanged

A TEvent that is invoked whenever setProgressDescription(Text) is called.

Constructor Details

DescriptiveProgressiveTask

public DescriptiveProgressiveTask()

Method Details

getProgressDescription

@Nullable
public final @Nullable net.minecraft.text.Text getProgressDescription()

Returns a user-friendly Text that describes what is currently going on as the task is executing.

setProgressDescription

protected final void setProgressDescription(@Nullable
 @Nullable net.minecraft.text.Text description)

Sets the user-friendly Text that describes what is currently going on as the task is executing.

Parameters:

description - The Text.