Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.client

Class HeadlessBrowser.FetchClearname

java.lang.Object

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

page.codeberg.friedolyn.client.FriedolinClient.FetchClearname

page.codeberg.friedolyn.client.HeadlessBrowser.FetchClearname

All Implemented Interfaces:

Runnable

Enclosing class:

HeadlessBrowser

public class HeadlessBrowser.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 was prematurely terminated by outside intervention.
private final @NonNull HashSet<Task.TaskListener<String>>	LISTENERS	The subscribers interested in the progress and status 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.
static final @lombok.NonNull int	TOTAL_WORK

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 fetching the student's clear name has been prematurely terminated by outside intervention.
private void	failed()	Notifies all subscribers that fetching the student's clear name has finished unsuccessfully.
@NonNull Optional<Result<String>>	getResult()
void	registerListener(@NonNull Task.TaskListener<String> taskListener)	Adds a subscriber that is interested in status updates of the action's progress.
boolean	removeListener(@NonNull Task.TaskListener<String> taskListener)	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 fetching the student's clear name has begun.
private void	succeeded()	Notifies all subscribers that fetching the student's clear name has succeeded.
private void	updateProgress(int current, int total)	Notifies all subscribers about the progress of this task.

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

TOTAL_WORK

@NonNull
public static final @lombok.NonNull int TOTAL_WORK

See Also:

• Constant Field Values

LISTENERS

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

The subscribers interested in the progress and status updates of this task.

result

@Nullable
private String result

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

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 was prematurely terminated by outside intervention.

Constructor Details

FetchClearname

public FetchClearname()

Method Details

updateProgress

private void updateProgress(int current,
 int total)

Notifies all subscribers about the progress of this task.

Parameters:

current - The amount of work that has been done so far.

total - The total number of steps required to complete this task.

started

private void started()

Notifies all subscribers that fetching the student's clear name has begun.

succeeded

private void succeeded()

Notifies all subscribers that fetching the student's clear name has succeeded.

failed

private void failed()

Notifies all subscribers that fetching the student's clear name has finished unsuccessfully.

cancelled

private void cancelled()

Notifies all subscribers that fetching the student's clear name has been prematurely terminated by outside intervention.

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>

registerListener

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

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:

taskListener - 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> taskListener)

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

Specified by:

removeListener in class Task<String>

Parameters:

taskListener - 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)

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).

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.