Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.gui.controllers

Class ContactController.OpenContactReplyDialogTask

java.lang.Object

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

page.codeberg.friedolyn.gui.controllers.ContactController.OpenContactReplyDialogTask

All Implemented Interfaces:

Runnable

Enclosing class:

ContactController

private class ContactController.OpenContactReplyDialogTask
extends Task<ContactMethods>

Displays the contact reply method dialog to the user.

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<ContactMethods>>	LISTENERS	The subscribers that will be notified about any status changes and progress updates of this task.
private ContactMethods	result	The result of the task.
private Boolean	success	Whether the task has been executed successfully.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	OpenContactReplyDialogTask()

Method Summary

Modifier and Type	Method	Description
void	cancel()	Prematurely terminates the action.
private void	cancelled()	Notifies all subscribers that the task was terminated prematurely by outside intervention.
private void	failed()	Notifies all subscribers that the contact reply dialog was closed unsuccessfully.
@NonNull Optional<Result<ContactMethods>>	getResult()
void	registerListener(@NonNull Task.TaskListener<ContactMethods> listener)	Adds a subscriber that is interested in status updates of the action's progress.
boolean	removeListener(@NonNull Task.TaskListener<ContactMethods> listener)	Removes a subscriber that was previously added to receive status updates of the action's progress.
void	run()	Opens the contact reply dialog window and waits for the user to close it.
private void	started()	Notifies all subscribers that the contact reply dialog has been opened.
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

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

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

result

@Nullable
private ContactMethods result

The result of the task. null until the task has finished.

success

@Nullable
private Boolean success

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

isCancelled

private boolean isCancelled

Whether the task has been prematurely terminated by outside intervention.

Constructor Details

OpenContactReplyDialogTask

private OpenContactReplyDialogTask()

Method Details

registerListener

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

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<ContactMethods> listener)

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

Specified by:

removeListener in class Task<ContactMethods>

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)

started

private void started()

Notifies all subscribers that the contact reply dialog has been opened.

failed

private void failed()

Notifies all subscribers that the contact reply dialog was closed unsuccessfully.

succeeded

private void succeeded()

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

cancelled

private void cancelled()

Notifies all subscribers that the task was terminated prematurely 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<ContactMethods>

run

public void run()

Opens the contact reply dialog window and waits for the user to close it. The result is then stored in result, ContactController.contactMethods and ContactController.configuration.

Specified by:

run in interface Runnable

Specified by:

run in class Task<ContactMethods>

getResult

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

Specified by:

getResult in class Task<ContactMethods>

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.