From f7265c884802647a9333bb31a64a3a4e6b827e7e Mon Sep 17 00:00:00 2001 From: gmungoc Date: Fri, 22 Apr 2016 15:37:40 +0100 Subject: [PATCH] JAL-2068 Javadoc added --- src/jalview/api/AlignCalcWorkerI.java | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/src/jalview/api/AlignCalcWorkerI.java b/src/jalview/api/AlignCalcWorkerI.java index 872528b..06dc054 100644 --- a/src/jalview/api/AlignCalcWorkerI.java +++ b/src/jalview/api/AlignCalcWorkerI.java @@ -22,12 +22,30 @@ package jalview.api; 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 { - + /** + * Answers true if this worker updates the given annotation (regardless of its + * current state) + * + * @param annot + * @return + */ public 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 + * settings are changed. + */ public void updateAnnotation(); - void removeOurAnnotation(); + /** + * Removes any annotation managed by this worker from the alignment + */ + void removeAnnotation(); } -- 1.7.10.2