*/
package jalview.api;
+import java.util.concurrent.Callable;
+
import jalview.datamodel.AlignmentAnnotation;
/**
* Interface describing a worker that calculates alignment annotation(s). The
* main (re-)calculation should be performed by the inherited run() method.
*/
-public interface AlignCalcWorkerI extends Runnable
+public interface AlignCalcWorkerI extends Callable<Void>
{
/**
* Answers true if this worker updates the given annotation (regardless of its
* @param annot
* @return
*/
- public boolean involves(AlignmentAnnotation annot);
+ boolean involves(AlignmentAnnotation annot);
/**
* Updates the display of calculated annotation values (does not recalculate
- * the values). This allows for quick redraw of annotations when display
+ * the values). This allows a quick redraw of annotations when display
* settings are changed.
*/
- public void updateAnnotation();
+ void updateAnnotation();
/**
- * Removes any annotation managed by this worker from the alignment
+ * Removes any annotation(s) managed by this worker from the alignment
*/
void removeAnnotation();
+
+
+ /**
+ * Default implementation of call which calls run and propagates the
+ * exception.
+ */
+ @Override
+ public default Void call() throws Exception
+ {
+ run();
+ return null;
+ }
+
+ /**
+ * The main calculation happens here
+ */
+ public void run() throws Exception;
+
+ /**
+ * Answers true if the worker should be deleted entirely when its annotation
+ * is deleted from the display, or false if it should continue to run. Some
+ * workers are required to run for their side-effects.
+ *
+ * @return
+ */
+ boolean isDeletable();
}