git://source.jalview.org
/
jalview.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (parent:
8fe8fc5
)
JAL-2068 Javadoc added
author
gmungoc
<g.m.carstairs@dundee.ac.uk>
Fri, 22 Apr 2016 14:37:40 +0000
(15:37 +0100)
committer
gmungoc
<g.m.carstairs@dundee.ac.uk>
Fri, 22 Apr 2016 14:37:40 +0000
(15:37 +0100)
src/jalview/api/AlignCalcWorkerI.java
patch
|
blob
|
history
diff --git
a/src/jalview/api/AlignCalcWorkerI.java
b/src/jalview/api/AlignCalcWorkerI.java
index
872528b
..
06dc054
100644
(file)
--- a/
src/jalview/api/AlignCalcWorkerI.java
+++ b/
src/jalview/api/AlignCalcWorkerI.java
@@
-22,12
+22,30
@@
package jalview.api;
import jalview.datamodel.AlignmentAnnotation;
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 Runnable
{
-
+ /**
+ * Answers true if this worker updates the given annotation (regardless of its
+ * current state)
+ *
+ * @param annot
+ * @return
+ */
public boolean involves(AlignmentAnnotation annot);
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();
public void updateAnnotation();
- void removeOurAnnotation();
+ /**
+ * Removes any annotation managed by this worker from the alignment
+ */
+ void removeAnnotation();
}
}