GPL license added
[jalview.git] / src / jalview / binding / VAMSAS.java
index b4237b8..2190b2f 100755 (executable)
@@ -1,10 +1,29 @@
 /*\r
- * This class was automatically generated with \r
+ * This class was automatically generated with\r
  * <a href="http://www.castor.org">Castor 0.9.6</a>, using an XML\r
  * Schema.\r
  * $Id$\r
  */\r
 \r
+/*\r
+* Jalview - A Sequence Alignment Editor and Viewer\r
+* Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
+*\r
+* This program is free software; you can redistribute it and/or\r
+* modify it under the terms of the GNU General Public License\r
+* as published by the Free Software Foundation; either version 2\r
+* of the License, or (at your option) any later version.\r
+*\r
+* This program is distributed in the hope that it will be useful,\r
+* but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
+* GNU General Public License for more details.\r
+*\r
+* You should have received a copy of the GNU General Public License\r
+* along with this program; if not, write to the Free Software\r
+* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
+*/\r
+\r
 package jalview.binding;\r
 \r
   //---------------------------------/\r
@@ -25,7 +44,7 @@ import org.xml.sax.ContentHandler;
 \r
 /**\r
  * Class VAMSAS.\r
- * \r
+ *\r
  * @version $Revision$ $Date$\r
  */\r
 public class VAMSAS implements java.io.Serializable {\r
@@ -69,22 +88,22 @@ public class VAMSAS implements java.io.Serializable {
 \r
     /**\r
      * Method addAlignment\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param vAlignment\r
      */\r
     public void addAlignment(jalview.binding.Alignment vAlignment)\r
         throws java.lang.IndexOutOfBoundsException\r
     {\r
         _alignmentList.addElement(vAlignment);\r
-    } //-- void addAlignment(jalview.binding.Alignment) \r
+    } //-- void addAlignment(jalview.binding.Alignment)\r
 \r
     /**\r
      * Method addAlignment\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @param vAlignment\r
      */\r
@@ -92,26 +111,26 @@ public class VAMSAS implements java.io.Serializable {
         throws java.lang.IndexOutOfBoundsException\r
     {\r
         _alignmentList.insertElementAt(vAlignment, index);\r
-    } //-- void addAlignment(int, jalview.binding.Alignment) \r
+    } //-- void addAlignment(int, jalview.binding.Alignment)\r
 \r
     /**\r
      * Method addSequenceSet\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param vSequenceSet\r
      */\r
     public void addSequenceSet(jalview.binding.SequenceSet vSequenceSet)\r
         throws java.lang.IndexOutOfBoundsException\r
     {\r
         _sequenceSetList.addElement(vSequenceSet);\r
-    } //-- void addSequenceSet(jalview.binding.SequenceSet) \r
+    } //-- void addSequenceSet(jalview.binding.SequenceSet)\r
 \r
     /**\r
      * Method addSequenceSet\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @param vSequenceSet\r
      */\r
@@ -119,26 +138,26 @@ public class VAMSAS implements java.io.Serializable {
         throws java.lang.IndexOutOfBoundsException\r
     {\r
         _sequenceSetList.insertElementAt(vSequenceSet, index);\r
-    } //-- void addSequenceSet(int, jalview.binding.SequenceSet) \r
+    } //-- void addSequenceSet(int, jalview.binding.SequenceSet)\r
 \r
     /**\r
      * Method addTree\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param vTree\r
      */\r
     public void addTree(java.lang.String vTree)\r
         throws java.lang.IndexOutOfBoundsException\r
     {\r
         _treeList.addElement(vTree);\r
-    } //-- void addTree(java.lang.String) \r
+    } //-- void addTree(java.lang.String)\r
 \r
     /**\r
      * Method addTree\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @param vTree\r
      */\r
@@ -146,49 +165,49 @@ public class VAMSAS implements java.io.Serializable {
         throws java.lang.IndexOutOfBoundsException\r
     {\r
         _treeList.insertElementAt(vTree, index);\r
-    } //-- void addTree(int, java.lang.String) \r
+    } //-- void addTree(int, java.lang.String)\r
 \r
     /**\r
      * Method enumerateAlignment\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return Enumeration\r
      */\r
     public java.util.Enumeration enumerateAlignment()\r
     {\r
         return _alignmentList.elements();\r
-    } //-- java.util.Enumeration enumerateAlignment() \r
+    } //-- java.util.Enumeration enumerateAlignment()\r
 \r
     /**\r
      * Method enumerateSequenceSet\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return Enumeration\r
      */\r
     public java.util.Enumeration enumerateSequenceSet()\r
     {\r
         return _sequenceSetList.elements();\r
-    } //-- java.util.Enumeration enumerateSequenceSet() \r
+    } //-- java.util.Enumeration enumerateSequenceSet()\r
 \r
     /**\r
      * Method enumerateTree\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return Enumeration\r
      */\r
     public java.util.Enumeration enumerateTree()\r
     {\r
         return _treeList.elements();\r
-    } //-- java.util.Enumeration enumerateTree() \r
+    } //-- java.util.Enumeration enumerateTree()\r
 \r
     /**\r
      * Method getAlignment\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @return Alignment\r
      */\r
@@ -199,15 +218,15 @@ public class VAMSAS implements java.io.Serializable {
         if ((index < 0) || (index > _alignmentList.size())) {\r
             throw new IndexOutOfBoundsException();\r
         }\r
-        \r
+\r
         return (jalview.binding.Alignment) _alignmentList.elementAt(index);\r
-    } //-- jalview.binding.Alignment getAlignment(int) \r
+    } //-- jalview.binding.Alignment getAlignment(int)\r
 \r
     /**\r
      * Method getAlignment\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return Alignment\r
      */\r
     public jalview.binding.Alignment[] getAlignment()\r
@@ -218,25 +237,25 @@ public class VAMSAS implements java.io.Serializable {
             mArray[index] = (jalview.binding.Alignment) _alignmentList.elementAt(index);\r
         }\r
         return mArray;\r
-    } //-- jalview.binding.Alignment[] getAlignment() \r
+    } //-- jalview.binding.Alignment[] getAlignment()\r
 \r
     /**\r
      * Method getAlignmentCount\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return int\r
      */\r
     public int getAlignmentCount()\r
     {\r
         return _alignmentList.size();\r
-    } //-- int getAlignmentCount() \r
+    } //-- int getAlignmentCount()\r
 \r
     /**\r
      * Method getSequenceSet\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @return SequenceSet\r
      */\r
@@ -247,15 +266,15 @@ public class VAMSAS implements java.io.Serializable {
         if ((index < 0) || (index > _sequenceSetList.size())) {\r
             throw new IndexOutOfBoundsException();\r
         }\r
-        \r
+\r
         return (jalview.binding.SequenceSet) _sequenceSetList.elementAt(index);\r
-    } //-- jalview.binding.SequenceSet getSequenceSet(int) \r
+    } //-- jalview.binding.SequenceSet getSequenceSet(int)\r
 \r
     /**\r
      * Method getSequenceSet\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return SequenceSet\r
      */\r
     public jalview.binding.SequenceSet[] getSequenceSet()\r
@@ -266,25 +285,25 @@ public class VAMSAS implements java.io.Serializable {
             mArray[index] = (jalview.binding.SequenceSet) _sequenceSetList.elementAt(index);\r
         }\r
         return mArray;\r
-    } //-- jalview.binding.SequenceSet[] getSequenceSet() \r
+    } //-- jalview.binding.SequenceSet[] getSequenceSet()\r
 \r
     /**\r
      * Method getSequenceSetCount\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return int\r
      */\r
     public int getSequenceSetCount()\r
     {\r
         return _sequenceSetList.size();\r
-    } //-- int getSequenceSetCount() \r
+    } //-- int getSequenceSetCount()\r
 \r
     /**\r
      * Method getTree\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @return String\r
      */\r
@@ -295,15 +314,15 @@ public class VAMSAS implements java.io.Serializable {
         if ((index < 0) || (index > _treeList.size())) {\r
             throw new IndexOutOfBoundsException();\r
         }\r
-        \r
+\r
         return (String)_treeList.elementAt(index);\r
-    } //-- java.lang.String getTree(int) \r
+    } //-- java.lang.String getTree(int)\r
 \r
     /**\r
      * Method getTree\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return String\r
      */\r
     public java.lang.String[] getTree()\r
@@ -314,25 +333,25 @@ public class VAMSAS implements java.io.Serializable {
             mArray[index] = (String)_treeList.elementAt(index);\r
         }\r
         return mArray;\r
-    } //-- java.lang.String[] getTree() \r
+    } //-- java.lang.String[] getTree()\r
 \r
     /**\r
      * Method getTreeCount\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return int\r
      */\r
     public int getTreeCount()\r
     {\r
         return _treeList.size();\r
-    } //-- int getTreeCount() \r
+    } //-- int getTreeCount()\r
 \r
     /**\r
      * Method isValid\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return boolean\r
      */\r
     public boolean isValid()\r
@@ -344,41 +363,41 @@ public class VAMSAS implements java.io.Serializable {
             return false;\r
         }\r
         return true;\r
-    } //-- boolean isValid() \r
+    } //-- boolean isValid()\r
 \r
     /**\r
      * Method marshal\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param out\r
      */\r
     public void marshal(java.io.Writer out)\r
         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
     {\r
-        \r
+\r
         Marshaller.marshal(this, out);\r
-    } //-- void marshal(java.io.Writer) \r
+    } //-- void marshal(java.io.Writer)\r
 \r
     /**\r
      * Method marshal\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param handler\r
      */\r
     public void marshal(org.xml.sax.ContentHandler handler)\r
         throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
     {\r
-        \r
+\r
         Marshaller.marshal(this, handler);\r
-    } //-- void marshal(org.xml.sax.ContentHandler) \r
+    } //-- void marshal(org.xml.sax.ContentHandler)\r
 \r
     /**\r
      * Method removeAlignment\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @return Alignment\r
      */\r
@@ -387,40 +406,40 @@ public class VAMSAS implements java.io.Serializable {
         java.lang.Object obj = _alignmentList.elementAt(index);\r
         _alignmentList.removeElementAt(index);\r
         return (jalview.binding.Alignment) obj;\r
-    } //-- jalview.binding.Alignment removeAlignment(int) \r
+    } //-- jalview.binding.Alignment removeAlignment(int)\r
 \r
     /**\r
      * Method removeAllAlignment\r
-     * \r
+     *\r
      */\r
     public void removeAllAlignment()\r
     {\r
         _alignmentList.removeAllElements();\r
-    } //-- void removeAllAlignment() \r
+    } //-- void removeAllAlignment()\r
 \r
     /**\r
      * Method removeAllSequenceSet\r
-     * \r
+     *\r
      */\r
     public void removeAllSequenceSet()\r
     {\r
         _sequenceSetList.removeAllElements();\r
-    } //-- void removeAllSequenceSet() \r
+    } //-- void removeAllSequenceSet()\r
 \r
     /**\r
      * Method removeAllTree\r
-     * \r
+     *\r
      */\r
     public void removeAllTree()\r
     {\r
         _treeList.removeAllElements();\r
-    } //-- void removeAllTree() \r
+    } //-- void removeAllTree()\r
 \r
     /**\r
      * Method removeSequenceSet\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @return SequenceSet\r
      */\r
@@ -429,13 +448,13 @@ public class VAMSAS implements java.io.Serializable {
         java.lang.Object obj = _sequenceSetList.elementAt(index);\r
         _sequenceSetList.removeElementAt(index);\r
         return (jalview.binding.SequenceSet) obj;\r
-    } //-- jalview.binding.SequenceSet removeSequenceSet(int) \r
+    } //-- jalview.binding.SequenceSet removeSequenceSet(int)\r
 \r
     /**\r
      * Method removeTree\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @return String\r
      */\r
@@ -444,13 +463,13 @@ public class VAMSAS implements java.io.Serializable {
         java.lang.Object obj = _treeList.elementAt(index);\r
         _treeList.removeElementAt(index);\r
         return (String)obj;\r
-    } //-- java.lang.String removeTree(int) \r
+    } //-- java.lang.String removeTree(int)\r
 \r
     /**\r
      * Method setAlignment\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @param vAlignment\r
      */\r
@@ -462,13 +481,13 @@ public class VAMSAS implements java.io.Serializable {
             throw new IndexOutOfBoundsException();\r
         }\r
         _alignmentList.setElementAt(vAlignment, index);\r
-    } //-- void setAlignment(int, jalview.binding.Alignment) \r
+    } //-- void setAlignment(int, jalview.binding.Alignment)\r
 \r
     /**\r
      * Method setAlignment\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param alignmentArray\r
      */\r
     public void setAlignment(jalview.binding.Alignment[] alignmentArray)\r
@@ -478,13 +497,13 @@ public class VAMSAS implements java.io.Serializable {
         for (int i = 0; i < alignmentArray.length; i++) {\r
             _alignmentList.addElement(alignmentArray[i]);\r
         }\r
-    } //-- void setAlignment(jalview.binding.Alignment) \r
+    } //-- void setAlignment(jalview.binding.Alignment)\r
 \r
     /**\r
      * Method setSequenceSet\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @param vSequenceSet\r
      */\r
@@ -496,13 +515,13 @@ public class VAMSAS implements java.io.Serializable {
             throw new IndexOutOfBoundsException();\r
         }\r
         _sequenceSetList.setElementAt(vSequenceSet, index);\r
-    } //-- void setSequenceSet(int, jalview.binding.SequenceSet) \r
+    } //-- void setSequenceSet(int, jalview.binding.SequenceSet)\r
 \r
     /**\r
      * Method setSequenceSet\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param sequenceSetArray\r
      */\r
     public void setSequenceSet(jalview.binding.SequenceSet[] sequenceSetArray)\r
@@ -512,13 +531,13 @@ public class VAMSAS implements java.io.Serializable {
         for (int i = 0; i < sequenceSetArray.length; i++) {\r
             _sequenceSetList.addElement(sequenceSetArray[i]);\r
         }\r
-    } //-- void setSequenceSet(jalview.binding.SequenceSet) \r
+    } //-- void setSequenceSet(jalview.binding.SequenceSet)\r
 \r
     /**\r
      * Method setTree\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @param vTree\r
      */\r
@@ -530,13 +549,13 @@ public class VAMSAS implements java.io.Serializable {
             throw new IndexOutOfBoundsException();\r
         }\r
         _treeList.setElementAt(vTree, index);\r
-    } //-- void setTree(int, java.lang.String) \r
+    } //-- void setTree(int, java.lang.String)\r
 \r
     /**\r
      * Method setTree\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param treeArray\r
      */\r
     public void setTree(java.lang.String[] treeArray)\r
@@ -546,13 +565,13 @@ public class VAMSAS implements java.io.Serializable {
         for (int i = 0; i < treeArray.length; i++) {\r
             _treeList.addElement(treeArray[i]);\r
         }\r
-    } //-- void setTree(java.lang.String) \r
+    } //-- void setTree(java.lang.String)\r
 \r
     /**\r
      * Method unmarshal\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param reader\r
      * @return Object\r
      */\r
@@ -560,17 +579,17 @@ public class VAMSAS implements java.io.Serializable {
         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
     {\r
         return (jalview.binding.VAMSAS) Unmarshaller.unmarshal(jalview.binding.VAMSAS.class, reader);\r
-    } //-- java.lang.Object unmarshal(java.io.Reader) \r
+    } //-- java.lang.Object unmarshal(java.io.Reader)\r
 \r
     /**\r
      * Method validate\r
-     * \r
+     *\r
      */\r
     public void validate()\r
         throws org.exolab.castor.xml.ValidationException\r
     {\r
         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
         validator.validate(this);\r
-    } //-- void validate() \r
+    } //-- void validate()\r
 \r
 }\r