X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fdatamodel%2FHistoryItem.java;h=eb4979d6c8ba2d8ea978cb2596fa3fcc016c2c4f;hb=f932cb5bb08dce9d7441c788d6996efaef53d15a;hp=bb18b661d40fb840c958b20c75febe8c44e5349e;hpb=99c58ee0ae2a848f982552e53feaf6d5cb9925e5;p=jalview.git

diff --git a/src/jalview/datamodel/HistoryItem.java b/src/jalview/datamodel/HistoryItem.java
index bb18b66..eb4979d 100755
--- a/src/jalview/datamodel/HistoryItem.java
+++ b/src/jalview/datamodel/HistoryItem.java
@@ -16,56 +16,109 @@
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */
-
 package jalview.datamodel;
 
 import java.util.*;
 
+
+/**
+ * DOCUMENT ME!
+ *
+ * @author $author$
+ * @version $Revision$
+ */
 public class HistoryItem
 {
-  public static final int EDIT = 0;
-  public static final int SORT = 1;
-  public static final int HIDE = 2;
-  public static final int PASTE= 3;
+    /** DOCUMENT ME!! */
+    public static final int EDIT = 0;
 
-  final int type;
-  Vector sequences;
-  Vector alignIndex;
-  String description;
-  Vector hiddenSeqs;
+    /** DOCUMENT ME!! */
+    public static final int SORT = 1;
 
-  public HistoryItem(String description, AlignmentI al, int type)
-  {
-    this.type = type;
-    this.description = description;
-    sequences = new Vector();
-    alignIndex = new Vector();
-    hiddenSeqs = new Vector();
+    /** DOCUMENT ME!! */
+    public static final int HIDE = 2;
 
-    for (int i = 0; i < al.getHeight(); i++)
+    /** DOCUMENT ME!! */
+    public static final int PASTE = 3;
+    final int type;
+    Vector sequences;
+    Vector alignIndex;
+    String description;
+    Vector hiddenSeqs;
+
+    /**
+     * Creates a new HistoryItem object.
+     *
+     * @param description DOCUMENT ME!
+     * @param al DOCUMENT ME!
+     * @param type DOCUMENT ME!
+     */
+    public HistoryItem(String description, AlignmentI al, int type)
     {
-      SequenceI seq = al.getSequenceAt(i);
-      sequences.addElement(seq);
-      alignIndex.addElement(i + "");
-      hiddenSeqs.addElement(seq.getSequence().toString());
-    }
-  }
+        this.type = type;
+        this.description = description;
+        sequences = new Vector();
+        alignIndex = new Vector();
+        hiddenSeqs = new Vector();
 
-  public int getType()
-  {return type;}
+        for (int i = 0; i < al.getHeight(); i++)
+        {
+            SequenceI seq = al.getSequenceAt(i);
+            sequences.addElement(seq);
+            alignIndex.addElement(i + "");
+            hiddenSeqs.addElement(seq.getSequence().toString());
+        }
+    }
 
-  public Vector getSequences()
-  {return sequences;}
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public int getType()
+    {
+        return type;
+    }
 
-  public String getDescription()
-  {return description; }
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public Vector getSequences()
+    {
+        return sequences;
+    }
 
-  public Vector getHidden()
-  { return hiddenSeqs; }
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public String getDescription()
+    {
+        return description;
+    }
 
-  public int getAlignIndex(int seq)
-  {
-    return Integer.parseInt(alignIndex.elementAt(seq).toString());
-  }
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public Vector getHidden()
+    {
+        return hiddenSeqs;
+    }
 
+    /**
+     * DOCUMENT ME!
+     *
+     * @param seq DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public int getAlignIndex(int seq)
+    {
+        return Integer.parseInt(alignIndex.elementAt(seq).toString());
+    }
 }