X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fdatamodel%2FHistoryItem.java;h=eb4979d6c8ba2d8ea978cb2596fa3fcc016c2c4f;hb=32ccffc95209f230faacf6f27394669c0dc8b271;hp=3a5b180bdf0cb11ff87668a0bd94b0ec2f3a0fb2;hpb=4c61bddcb9e367db694e3f2bde9c4d25f114f50b;p=jalview.git

diff --git a/src/jalview/datamodel/HistoryItem.java b/src/jalview/datamodel/HistoryItem.java
index 3a5b180..eb4979d 100755
--- a/src/jalview/datamodel/HistoryItem.java
+++ b/src/jalview/datamodel/HistoryItem.java
@@ -1,52 +1,124 @@
+/*
+* Jalview - A Sequence Alignment Editor and Viewer
+* Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+*
+* This program 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 2
+* of the License, or (at your option) any later version.
+*
+* This program 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 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;
-
-  final int type;
-  Vector sequences;
-  Vector alignIndex;
-  String description;
-  Vector hiddenSeqs;
-
-  public HistoryItem(String description, AlignmentI al, int type)
-  {
-    this.type = type;
-    this.description = description;
-    sequences = new Vector();
-    alignIndex = new Vector();
-    hiddenSeqs = new Vector();
-
-    for (int i = 0; i < al.getHeight(); i++)
+    /** DOCUMENT ME!! */
+    public static final int EDIT = 0;
+
+    /** DOCUMENT ME!! */
+    public static final int SORT = 1;
+
+    /** DOCUMENT ME!! */
+    public static final int HIDE = 2;
+
+    /** 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());
+    }
 }