Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.util

Class Task.TaskListener<ResultType>

java.lang.Object

page.codeberg.friedolyn.util.Task.TaskListener<ResultType>

Type Parameters:

ResultType - The class of the end product that the action executed generates.

All Implemented Interfaces:

Task.CancelListener, Task.FailureListener<ResultType>, Task.ProgressListener, Task.SuccessListener<ResultType>

Enclosing class:

Task<ResultType>

public abstract static class Task.TaskListener<ResultType>
extends Object
implements Task.ProgressListener, Task.SuccessListener<ResultType>, Task.FailureListener<ResultType>, Task.CancelListener

A subscriber that is interested in status updates of the action's progress.

See Also:

• onStarted()
• Task.ProgressListener.onProgressUpdate(int, int)
• Task.SuccessListener.onSucceeded(Object)
• Task.FailureListener.onFailed(Optional)
• Task.CancelListener.onCancelled()
• Task.registerListener(TaskListener)

Constructor Summary

Constructors

Constructor	Description
TaskListener()

Method Summary

Modifier and Type	Method	Description
static <ResultType> @NonNull Task.TaskListener<ResultType>	from(@NonNull Task.CancelListener cancelListener)	Converts a Task.CancelListener to a Task.TaskListener.
static <ResultType> @NonNull Task.TaskListener<ResultType>	from(@NonNull Task.FailureListener<ResultType> failureListener)	Converts a Task.FailureListener to a Task.TaskListener.
static <ResultType> @NonNull Task.TaskListener<ResultType>	from(@NonNull Task.ProgressListener progressListener)	Converts a Task.ProgressListener to a Task.TaskListener.
static <ResultType> @NonNull Task.TaskListener<ResultType>	from(@NonNull Task.SuccessListener<ResultType> successListener)	Converts a Task.SuccessListener to a Task.TaskListener.
abstract void	onStarted()	Called when execution of the action has begun.

Methods inherited from class java.lang.Object

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

Methods inherited from interface page.codeberg.friedolyn.util.Task.CancelListener

onCancelled

Methods inherited from interface page.codeberg.friedolyn.util.Task.FailureListener

onFailed

Methods inherited from interface page.codeberg.friedolyn.util.Task.ProgressListener

onProgressUpdate

Methods inherited from interface page.codeberg.friedolyn.util.Task.SuccessListener

onSucceeded

Constructor Details

TaskListener

public TaskListener()

Method Details

onStarted

public abstract void onStarted()

Called when execution of the action has begun.

from

@NonNull
public static <ResultType>
@NonNull Task.TaskListener<ResultType> from(@NonNull
 @NonNull Task.ProgressListener progressListener)

Converts a Task.ProgressListener to a Task.TaskListener. Useful if only progress updates are needed and no other information.

Type Parameters:

ResultType - The class of the result that the action executed produces.

Parameters:

progressListener - What to do when progress has been made executing the task. Will be called by Task.ProgressListener.onProgressUpdate(int, int).

Returns:

A Task.TaskListener that calls the given Task.ProgressListener when progress is made.

See Also:

• Task.ProgressListener.onProgressUpdate(int, int)
• from(SuccessListener)
• from(FailureListener)
• from(CancelListener)

from

@NonNull
public static <ResultType>
@NonNull Task.TaskListener<ResultType> from(@NonNull
 @NonNull Task.SuccessListener<ResultType> successListener)

Converts a Task.SuccessListener to a Task.TaskListener. Useful if only the result is needed and no other information.

Type Parameters:

ResultType - The class of the result that the action executed produces.

Parameters:

successListener - What to do when the action has succeeded. Will be called by Task.SuccessListener.onSucceeded(Object).

Returns:

A Task.TaskListener that calls the given Task.SuccessListener when the action has succeeded.

from

@NonNull
public static <ResultType>
@NonNull Task.TaskListener<ResultType> from(@NonNull
 @NonNull Task.FailureListener<ResultType> failureListener)

Converts a Task.FailureListener to a Task.TaskListener. Useful if only the result is needed and no other information.

Type Parameters:

ResultType - The class of the result that the action executed produces.

Parameters:

failureListener - What to do when the action has failed. Will be called by Task.FailureListener.onFailed(Optional).

Returns:

A Task.TaskListener that calls the given Task.FailureListener when the action has failed.

from

@NonNull
public static <ResultType>
@NonNull Task.TaskListener<ResultType> from(@NonNull
 @NonNull Task.CancelListener cancelListener)

Converts a Task.CancelListener to a Task.TaskListener. Useful if only the result is needed and no other information.

Type Parameters:

ResultType - The class of the result that the action executed produces.

Parameters:

cancelListener - What to do when the action has been cancelled. Will be called by Task.CancelListener.onCancelled().

Returns:

A Task.TaskListener that calls the given Task.CancelListener when the action has been cancelled.