Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.client

Class Client.FetchClearname

java.lang.Object

page.codeberg.friedolyn.util.Task<String>

page.codeberg.friedolyn.client.FriedolinClient.FetchClearname

page.codeberg.friedolyn.client.Client.FetchClearname

All Implemented Interfaces:

Runnable

Enclosing class:

Client

public class Client.FetchClearname
extends FriedolinClient.FetchClearname

See Also:

• FriedolinClient.FetchClearname

Nested Class Summary

Nested classes/interfaces inherited from class page.codeberg.friedolyn.util.Task

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

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	isCancelled	Whether the task has been prematurely terminated by outside intervention.
private final @NonNull HashSet<Task.TaskListener<String>>	LISTENERS	The subscribers that will be notified about any status changes and progress updates of this task.
private String	result	The student's clear name fetched from Friedolin.
private Boolean	success	Whether fetching the student's clear name was successful.

Constructor Summary

Constructors

Constructor	Description
FetchClearname()

Method Summary

Modifier and Type	Method	Description
void	cancel()	Prematurely terminates the action.
private void	cancelled()	Notifies all subscribers that the fetching process was terminated prematurely by outside intervention.
private void	failed()	Notifies all subscribers that the fetching process finished unsuccessfully.
@NonNull Optional<Result<String>>	getResult()
void	registerListener(@NonNull Task.TaskListener<String> listener)	Adds a subscriber that is interested in status updates of the action's progress.
boolean	removeListener(@NonNull Task.TaskListener<String> listener)	Removes a subscriber that was previously added to receive status updates of the action's progress.
void	run()	Begins the execution of the action.
private void	started()	Notifies all subscribers that the fetching process has begun.
private void	succeeded()	Notifies all subscribers that the fetching process finished successfully.
private void	updateProgress(int current, int total)	Notifies all subscribers about the amount of work that has already been done and the total amount of work that needs to be done to finish fetching the student's clear name.

Methods inherited from class page.codeberg.friedolyn.util.Task

setOnCancelled, setOnFailed, setOnProgressUpdate, setOnSucceeded

Methods inherited from class java.lang.Object

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

Field Details

result

@Nullable
private String result

The student's clear name fetched from Friedolin. null until the task has finished.

success

@Nullable
private Boolean success

Whether fetching the student's clear name was successful. null until the task has finished.

isCancelled

private boolean isCancelled

Whether the task has been prematurely terminated by outside intervention.

LISTENERS

@NonNull
private final @NonNull HashSet<Task.TaskListener<String>> LISTENERS

The subscribers that will be notified about any status changes and progress updates of this task.

Constructor Details

FetchClearname

public FetchClearname()

Method Details

updateProgress

private void updateProgress(int current,
 int total)

Notifies all subscribers about the amount of work that has already been done and the total amount of work that needs to be done to finish fetching the student's clear name.

started

private void started()

Notifies all subscribers that the fetching process has begun.

failed

private void failed()

Notifies all subscribers that the fetching process finished unsuccessfully.

succeeded

private void succeeded()

Notifies all subscribers that the fetching process finished successfully. Does nothing if result is null.

registerListener

public void registerListener(@NonNull
 @NonNull Task.TaskListener<String> listener)

Adds a subscriber that is interested in status updates of the action's progress. Does NOT remove or replace any existing listeners.

Specified by:

registerListener in class Task<String>

Parameters:

listener - The subscriber that wants to be informed about the progress of the action.

See Also:

• Task.removeListener(TaskListener)

removeListener

public boolean removeListener(@NonNull
 @NonNull Task.TaskListener<String> listener)

Removes a subscriber that was previously added to receive status updates of the action's progress.

Specified by:

removeListener in class Task<String>

Parameters:

listener - The subscriber that no longer wants to be informed about the progress of the action. Must be the exact same reference that was previously registered.

Returns:

true if the subscriber was removed, false if it hadn't been registered in the first place.

See Also:

• Task.registerListener(TaskListener)

cancel

public void cancel()

Prematurely terminates the action. The action will be stopped as soon as possible, but it may not be immediate, depending on the implementation.

Specified by:

cancel in class Task<String>

cancelled

private void cancelled()

Notifies all subscribers that the fetching process was terminated prematurely by outside intervention.

getResult

@NonNull
public @NonNull Optional<Result<String>> getResult()

Specified by:

getResult in class Task<String>

Returns:

The end product generated by the action. Empty if the action has not finished yet. The presence of Result.getResult() does NOT indicate success. Only Result.getSuccess() can be used to determine success or failure.

run

public void run()
         throws IllegalStateException

Begins the execution of the action. The action will run in the same thread that it was envoked from. Use Task.cancel() to prematurely terminate the action. The end product of the action can be retrieved using Task.getResult().

Specified by:

run in interface Runnable

Specified by:

run in class Task<String>

Throws:

IllegalStateException - If the action had been started before (each task can only be run once).