Merge branch 'JAL-3878_ws-overhaul-3' into with_ws_overhaul-3
[jalview.git] / src / jalview / ws2 / actions / alignment / AlignmentResult.java
1 package jalview.ws2.actions.alignment;
2
3 import java.util.List;
4
5 import jalview.datamodel.AlignmentI;
6 import jalview.datamodel.AlignmentOrder;
7 import jalview.datamodel.HiddenColumns;
8 import jalview.ws2.actions.api.TaskEventListener;
9
10 /**
11  * A data container storing the output of multiple sequence alignment services.
12  * The object is constructed by an {@link AlignmentTask} on completion and
13  * passed to the handler {@link TaskEventListener#taskCompleted(TaskI, Object)}
14  * method as a result.
15  * 
16  * @author mmwarowny
17  */
18 public class AlignmentResult
19 {
20   final AlignmentI aln;
21
22   final List<AlignmentOrder> alorders;
23
24   final HiddenColumns hidden;
25
26   AlignmentResult(AlignmentI aln, List<AlignmentOrder> alorders,
27       HiddenColumns hidden)
28   {
29     this.aln = aln;
30     this.alorders = alorders;
31     this.hidden = hidden;
32   }
33
34   public AlignmentI getAlignment()
35   {
36     return aln;
37   }
38
39   public List<AlignmentOrder> getAlignmentOrders()
40   {
41     return alorders;
42   }
43
44   public HiddenColumns getHiddenColumns()
45   {
46     return hidden;
47   }
48 }