Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.gui.controllers

Class ContactController.SubmitTask

java.lang.Object

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

page.codeberg.friedolyn.gui.controllers.ContactController.SubmitTask

All Implemented Interfaces:

Runnable

Enclosing class:

ContactController

private class ContactController.SubmitTask
extends Task<Boolean>

Sends the user's request to the developers via e-mail.

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

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SubmitTask()

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 task failed.
@NonNull Optional<Result<Boolean>>	getResult()
private @NonNull Optional<File>	loadLogFile()	Tries to locate the log file in the logs directory relative to the invalid reference configuration directory .
void	registerListener(@NonNull Task.TaskListener<Boolean> listener)	Adds a subscriber that is interested in status updates of the action's progress.
boolean	removeListener(@NonNull Task.TaskListener<Boolean> listener)	Removes a subscriber that was previously added to receive status updates of the action's progress.
void	run()	Sends the user's request to the developers via e-mail.
private void	started()	Notifies all subscribers that the e-mail sending process has begun.
private void	succeeded()	Notifies all subscribers that the task was completed 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<Boolean>> 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.

isCancelled

private boolean isCancelled

Whether the task has been prematurely terminated by outside intervention.

Constructor Details

SubmitTask

private SubmitTask()

Method Details

started

private void started()

Notifies all subscribers that the e-mail sending process has begun.

failed

private void failed()

Notifies all subscribers that the task failed.

succeeded

private void succeeded()

Notifies all subscribers that the task was completed successfully.

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<Boolean>

registerListener

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

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

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

Specified by:

removeListener in class Task<Boolean>

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)

run

public void run()

Sends the user's request to the developers via e-mail. The user's message is encrypted using the developer's OpenPGP public key.

Specified by:

run in interface Runnable

Specified by:

run in class Task<Boolean>

loadLogFile

@NonNull
private @NonNull Optional<File> loadLogFile()

Tries to locate the log file in the logs directory relative to the

invalid reference

configuration directory

.

Returns:

The log file. Empty if the log file could not be found, is not a file or cannot be read.

getResult

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

Specified by:

getResult in class Task<Boolean>

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.