JAL-1894 update year/version in copyright

[jalview.git] / src / jalview / commands / OrderCommand.java

diff --git a/src/jalview/commands/OrderCommand.java b/src/jalview/commands/OrderCommand.java
index fbfb9ed..f6d3b46 100644 (file)
--- a/src/jalview/commands/OrderCommand.java
+++ b/src/jalview/commands/OrderCommand.java
@@ -1,36 +1,65 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
- * Copyright (C) 2014 The Jalview Authors
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9.0b1)
+ * Copyright (C) 2015 The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
  * Jalview is free software: you can redistribute it and/or
  * modify it under the terms of the GNU General Public License 
- * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
  *  
  * Jalview is distributed in the hope that it will be useful, but 
  * WITHOUT ANY WARRANTY; without even the implied warranty 
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
  * PURPOSE.  See the GNU General Public License for more details.
  * 
- * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.commands;
 
-import jalview.analysis.*;
-import jalview.datamodel.*;
+import jalview.analysis.AlignmentSorter;
+import jalview.datamodel.AlignmentI;
+import jalview.datamodel.SequenceI;
 
+/**
+ * An undoable command to reorder the sequences in an alignment.
+ * 
+ * @author gmcarstairs
+ *
+ */
 public class OrderCommand implements CommandI
 {
   String description;
 
+  /*
+   * The sequence order before sorting (target order for an undo)
+   */
   SequenceI[] seqs;
 
+  /*
+   * The sequence order specified by this command
+   */
   SequenceI[] seqs2;
 
+  /*
+   * The alignment the command acts on
+   */
   AlignmentI al;
 
+  /**
+   * Constructor given the 'undo' sequence order, and the (already) sorted
+   * alignment.
+   * 
+   * @param description
+   *          a text label for the 'undo' menu option
+   * @param seqs
+   *          the sequence order for undo
+   * @param al
+   *          the alignment as ordered by this command
+   */
   public OrderCommand(String description, SequenceI[] seqs, AlignmentI al)
   {
     this.description = description;
@@ -59,4 +88,15 @@ public class OrderCommand implements CommandI
   {
     AlignmentSorter.setOrder(al, seqs);
   }
+
+  /**
+   * Returns the sequence order used to sort, or before sorting if undo=true.
+   * 
+   * @param undo
+   * @return
+   */
+  public SequenceI[] getSequenceOrder(boolean undo)
+  {
+    return undo ? seqs : seqs2;
+  }
 }