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

[jalview.git] / src / jalview / ws2 / actions / alignment / AlignmentResult.java

diff --git a/src/jalview/ws2/actions/alignment/AlignmentResult.java b/src/jalview/ws2/actions/alignment/AlignmentResult.java
new file mode 100644 (file)
index 0000000..9090dd2
--- /dev/null
+++ b/src/jalview/ws2/actions/alignment/AlignmentResult.java
@@ -0,0 +1,48 @@
+package jalview.ws2.actions.alignment;
+
+import java.util.List;
+
+import jalview.datamodel.AlignmentI;
+import jalview.datamodel.AlignmentOrder;
+import jalview.datamodel.HiddenColumns;
+import jalview.ws2.actions.api.TaskEventListener;
+
+/**
+ * A data container storing the output of multiple sequence alignment services.
+ * The object is constructed by an {@link AlignmentTask} on completion and
+ * passed to the handler {@link TaskEventListener#taskCompleted(TaskI, Object)}
+ * method as a result.
+ * 
+ * @author mmwarowny
+ */
+public class AlignmentResult
+{
+  final AlignmentI aln;
+
+  final List<AlignmentOrder> alorders;
+
+  final HiddenColumns hidden;
+
+  AlignmentResult(AlignmentI aln, List<AlignmentOrder> alorders,
+      HiddenColumns hidden)
+  {
+    this.aln = aln;
+    this.alorders = alorders;
+    this.hidden = hidden;
+  }
+
+  public AlignmentI getAlignment()
+  {
+    return aln;
+  }
+
+  public List<AlignmentOrder> getAlignmentOrders()
+  {
+    return alorders;
+  }
+
+  public HiddenColumns getHiddenColumns()
+  {
+    return hidden;
+  }
+}