Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.crypto

Class KeePassXC.AssociateAndLoginTask

java.lang.Object

page.codeberg.friedolyn.util.Task<KeePassXC.KeePassEntry>

page.codeberg.friedolyn.crypto.KeePassXC.AssociateAndLoginTask

All Implemented Interfaces:

Runnable

Enclosing class:

KeePassXC

private class KeePassXC.AssociateAndLoginTask
extends Task<KeePassXC.KeePassEntry>

A Task that does KeePassXC.connect(), KeePassXC.associate(), and KeePassXC.getFriedolinLogins() all in one go.

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 HashSet<Task.TaskListener<KeePassXC.KeePassEntry>>	LISTENERS	The subscribers that will be notified about any status changes and progress updates of this task.
private KeePassXC.KeePassEntry	result	The student's Friedolin login credentials.
private Boolean	success	Whether the task has been executed successfully.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AssociateAndLoginTask()

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<KeePassXC.KeePassEntry>>	getResult()
void	registerListener(@NonNull Task.TaskListener<KeePassXC.KeePassEntry> taskListener)	Adds a subscriber that is interested in status updates of the action's progress.
boolean	removeListener(@NonNull Task.TaskListener<KeePassXC.KeePassEntry> 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	succeeded()	Notifies all subscribers that the fetching process finished successfully.

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

LISTENERS

private final HashSet<Task.TaskListener<KeePassXC.KeePassEntry>> LISTENERS

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

success

@Nullable
private Boolean success

Whether the task has been executed successfully. null until the task has finished.

result

@Nullable
private KeePassXC.KeePassEntry result

The student's Friedolin login credentials. null until the task has finished.

isCancelled

private boolean isCancelled

Whether the task has been prematurely terminated by outside intervention.

Constructor Details

AssociateAndLoginTask

private AssociateAndLoginTask()

Method Details

registerListener

public void registerListener(@NonNull
 @NonNull Task.TaskListener<KeePassXC.KeePassEntry> 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<KeePassXC.KeePassEntry>

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<KeePassXC.KeePassEntry> taskListener)

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

Specified by:

removeListener in class Task<KeePassXC.KeePassEntry>

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)

succeeded

private void succeeded()

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

failed

private void failed()

Notifies all subscribers that the fetching process finished unsuccessfully.

cancelled

private void cancelled()

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

run

public void run()

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<KeePassXC.KeePassEntry>

cancel

public void cancel()
            throws IllegalStateException

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<KeePassXC.KeePassEntry>

Throws:

IllegalStateException - If the action had not been started before or if it has already finished.

getResult

@NonNull
public @NonNull Optional<Result<KeePassXC.KeePassEntry>> getResult()

Specified by:

getResult in class Task<KeePassXC.KeePassEntry>

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.