git://source.jalview.org
/
jalview.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
JAL-3690 Documentation for AlignCalcListener
[jalview.git]
/
src
/
jalview
/
api
/
AlignCalcListener.java
diff --git
a/src/jalview/api/AlignCalcListener.java
b/src/jalview/api/AlignCalcListener.java
index
2e40f87
..
9ce385d
100644
(file)
--- a/
src/jalview/api/AlignCalcListener.java
+++ b/
src/jalview/api/AlignCalcListener.java
@@
-2,11
+2,38
@@
package jalview.api;
import java.util.EventListener;
import java.util.EventListener;
+/**
+ * A listener class which receives state updates of {@link AlignCalcWorkerI}.
+ * It can be registered with an {@link AlignCalcManagerI2}.
+ *
+ * @author mmwarowny
+ *
+ */
public interface AlignCalcListener extends EventListener
{
public interface AlignCalcListener extends EventListener
{
+ /**
+ * Called when the worker is scheduler for execution with
+ * {@link AlignCalcManagerI2#startWorker(AlignCalcWorkerI)}.
+ */
default void workerQueued(AlignCalcWorkerI worker) {}
default void workerQueued(AlignCalcWorkerI worker) {}
+
+ /**
+ * Called when the worker starts calculations.
+ */
default void workerStarted(AlignCalcWorkerI worker) {}
default void workerStarted(AlignCalcWorkerI worker) {}
+
+ /**
+ * Called when the worker finishes successfully.
+ */
default void workerCompleted(AlignCalcWorkerI worker) {}
default void workerCompleted(AlignCalcWorkerI worker) {}
+
+ /**
+ * Called when the worker is cancelled.
+ */
default void workerCancelled(AlignCalcWorkerI worker) {}
default void workerCancelled(AlignCalcWorkerI worker) {}
+
+ /**
+ * Called when the worker finishes with an exception.
+ */
default void workerExceptional(AlignCalcWorkerI worker, Throwable throwable) {}
}
default void workerExceptional(AlignCalcWorkerI worker, Throwable throwable) {}
}