Merge branch 'JAL-3878_ws-overhaul-3' into mmw/Release_2_12_ws_merge

[jalview.git] / src / jalview / ws2 / actions / annotation / AnnotationResult.java

diff --git a/src/jalview/ws2/actions/annotation/AnnotationResult.java b/src/jalview/ws2/actions/annotation/AnnotationResult.java
new file mode 100644 (file)
index 0000000..373ecbb
--- /dev/null
+++ b/src/jalview/ws2/actions/annotation/AnnotationResult.java
@@ -0,0 +1,56 @@
+package jalview.ws2.actions.annotation;
+
+import java.util.List;
+import java.util.Map;
+
+import jalview.api.FeatureColourI;
+import jalview.datamodel.AlignmentAnnotation;
+import jalview.datamodel.features.FeatureMatcherSetI;
+
+/**
+ * A simple data container storing the output of annotation tasks. The object is
+ * constructed on {@link AnnotationTask} completion and passed to an appropriate
+ * handler.
+ * 
+ * @author mmwarowny
+ *
+ */
+public class AnnotationResult
+{
+  final List<AlignmentAnnotation> annotations;
+
+  final boolean transferFeatures;
+
+  final Map<String, FeatureColourI> featureColours;
+
+  final Map<String, FeatureMatcherSetI> featureFilters;
+
+  public AnnotationResult(List<AlignmentAnnotation> annotations, boolean transferFeatures,
+      Map<String, FeatureColourI> featureColours, Map<String, FeatureMatcherSetI> featureFilters)
+  {
+    this.annotations = annotations;
+    this.transferFeatures = transferFeatures;
+    this.featureColours = featureColours;
+    this.featureFilters = featureFilters;
+  }
+
+  public List<AlignmentAnnotation> getAnnotations()
+  {
+    return annotations;
+  }
+  
+  public boolean getTransferFeatures()
+  {
+    return transferFeatures;
+  }
+
+  public Map<String, FeatureColourI> getFeatureColours()
+  {
+    return featureColours;
+  }
+
+  public Map<String, FeatureMatcherSetI> getFeatureFilters()
+  {
+    return featureFilters;
+  }
+}