Formatting changes
[jalview.git] / src / jalview / binding / SequenceSet.java
index 7ed3b52..a0d116e 100755 (executable)
@@ -1,38 +1,39 @@
 /*\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
 package jalview.binding;\r
 \r
-  //---------------------------------/\r
- //- Imported classes and packages -/\r
-//---------------------------------/\r
+import org.exolab.castor.xml.MarshalException;\r
+import org.exolab.castor.xml.Marshaller;\r
+import org.exolab.castor.xml.Unmarshaller;\r
+import org.exolab.castor.xml.ValidationException;\r
+\r
+import org.xml.sax.ContentHandler;\r
 \r
+//---------------------------------/\r
+//- Imported classes and packages -/\r
+//---------------------------------/\r
 import java.io.IOException;\r
 import java.io.Reader;\r
 import java.io.Serializable;\r
 import java.io.Writer;\r
+\r
 import java.util.Enumeration;\r
 import java.util.Vector;\r
-import org.exolab.castor.xml.MarshalException;\r
-import org.exolab.castor.xml.Marshaller;\r
-import org.exolab.castor.xml.Unmarshaller;\r
-import org.exolab.castor.xml.ValidationException;\r
-import org.xml.sax.ContentHandler;\r
+\r
 \r
 /**\r
  * Class SequenceSet.\r
- * \r
+ *\r
  * @version $Revision$ $Date$\r
  */\r
-public class SequenceSet implements java.io.Serializable {\r
-\r
-\r
-      //--------------------------/\r
-     //- Class/Member Variables -/\r
+public class SequenceSet implements java.io.Serializable\r
+{\r
+    //--------------------------/\r
+    //- Class/Member Variables -/\r
     //--------------------------/\r
 \r
     /**\r
@@ -60,40 +61,39 @@ public class SequenceSet implements java.io.Serializable {
      */\r
     private java.util.Vector _annotationList;\r
 \r
-\r
-      //----------------/\r
-     //- Constructors -/\r
     //----------------/\r
-\r
-    public SequenceSet() {\r
+    //- Constructors -/\r
+    //----------------/\r
+    public SequenceSet()\r
+    {\r
         super();\r
         _sequenceList = new Vector();\r
         _annotationList = new Vector();\r
-    } //-- jalview.binding.SequenceSet()\r
-\r
+    }\r
 \r
-      //-----------/\r
-     //- Methods -/\r
+    //-- jalview.binding.SequenceSet()\r
     //-----------/\r
 \r
     /**\r
-     * Method addAnnotation\r
-     * \r
-     * \r
-     * \r
-     * @param vAnnotation\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param vAnnotation DOCUMENT ME!\r
+     *\r
+     * @throws java.lang.IndexOutOfBoundsException DOCUMENT ME!\r
      */\r
     public void addAnnotation(jalview.binding.Annotation vAnnotation)\r
         throws java.lang.IndexOutOfBoundsException\r
     {\r
         _annotationList.addElement(vAnnotation);\r
-    } //-- void addAnnotation(jalview.binding.Annotation) \r
+    }\r
+\r
+    //-- void addAnnotation(jalview.binding.Annotation) \r
 \r
     /**\r
      * Method addAnnotation\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @param vAnnotation\r
      */\r
@@ -101,26 +101,30 @@ public class SequenceSet implements java.io.Serializable {
         throws java.lang.IndexOutOfBoundsException\r
     {\r
         _annotationList.insertElementAt(vAnnotation, index);\r
-    } //-- void addAnnotation(int, jalview.binding.Annotation) \r
+    }\r
+\r
+    //-- void addAnnotation(int, jalview.binding.Annotation) \r
 \r
     /**\r
      * Method addSequence\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param vSequence\r
      */\r
     public void addSequence(jalview.binding.Sequence vSequence)\r
         throws java.lang.IndexOutOfBoundsException\r
     {\r
         _sequenceList.addElement(vSequence);\r
-    } //-- void addSequence(jalview.binding.Sequence) \r
+    }\r
+\r
+    //-- void addSequence(jalview.binding.Sequence) \r
 \r
     /**\r
      * Method addSequence\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @param vSequence\r
      */\r
@@ -128,57 +132,67 @@ public class SequenceSet implements java.io.Serializable {
         throws java.lang.IndexOutOfBoundsException\r
     {\r
         _sequenceList.insertElementAt(vSequence, index);\r
-    } //-- void addSequence(int, jalview.binding.Sequence) \r
+    }\r
+\r
+    //-- void addSequence(int, jalview.binding.Sequence) \r
 \r
     /**\r
      * Method deleteAligned\r
-     * \r
+     *\r
      */\r
     public void deleteAligned()\r
     {\r
-        this._has_aligned= false;\r
-    } //-- void deleteAligned() \r
+        this._has_aligned = false;\r
+    }\r
+\r
+    //-- void deleteAligned() \r
 \r
     /**\r
      * Method enumerateAnnotation\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return Enumeration\r
      */\r
     public java.util.Enumeration enumerateAnnotation()\r
     {\r
         return _annotationList.elements();\r
-    } //-- java.util.Enumeration enumerateAnnotation() \r
+    }\r
+\r
+    //-- java.util.Enumeration enumerateAnnotation() \r
 \r
     /**\r
      * Method enumerateSequence\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return Enumeration\r
      */\r
     public java.util.Enumeration enumerateSequence()\r
     {\r
         return _sequenceList.elements();\r
-    } //-- java.util.Enumeration enumerateSequence() \r
+    }\r
+\r
+    //-- java.util.Enumeration enumerateSequence() \r
 \r
     /**\r
      * Returns the value of field 'aligned'.\r
-     * \r
+     *\r
      * @return boolean\r
      * @return the value of field 'aligned'.\r
      */\r
     public boolean getAligned()\r
     {\r
         return this._aligned;\r
-    } //-- boolean getAligned() \r
+    }\r
+\r
+    //-- boolean getAligned() \r
 \r
     /**\r
      * Method getAnnotation\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @return Annotation\r
      */\r
@@ -186,58 +200,70 @@ public class SequenceSet implements java.io.Serializable {
         throws java.lang.IndexOutOfBoundsException\r
     {\r
         //-- check bounds for index\r
-        if ((index < 0) || (index > _annotationList.size())) {\r
+        if ((index < 0) || (index > _annotationList.size()))\r
+        {\r
             throw new IndexOutOfBoundsException();\r
         }\r
-        \r
+\r
         return (jalview.binding.Annotation) _annotationList.elementAt(index);\r
-    } //-- jalview.binding.Annotation getAnnotation(int) \r
+    }\r
+\r
+    //-- jalview.binding.Annotation getAnnotation(int) \r
 \r
     /**\r
      * Method getAnnotation\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return Annotation\r
      */\r
     public jalview.binding.Annotation[] getAnnotation()\r
     {\r
         int size = _annotationList.size();\r
         jalview.binding.Annotation[] mArray = new jalview.binding.Annotation[size];\r
-        for (int index = 0; index < size; index++) {\r
+\r
+        for (int index = 0; index < size; index++)\r
+        {\r
             mArray[index] = (jalview.binding.Annotation) _annotationList.elementAt(index);\r
         }\r
+\r
         return mArray;\r
-    } //-- jalview.binding.Annotation[] getAnnotation() \r
+    }\r
+\r
+    //-- jalview.binding.Annotation[] getAnnotation() \r
 \r
     /**\r
      * Method getAnnotationCount\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return int\r
      */\r
     public int getAnnotationCount()\r
     {\r
         return _annotationList.size();\r
-    } //-- int getAnnotationCount() \r
+    }\r
+\r
+    //-- int getAnnotationCount() \r
 \r
     /**\r
      * Returns the value of field 'gapChar'.\r
-     * \r
+     *\r
      * @return String\r
      * @return the value of field 'gapChar'.\r
      */\r
     public java.lang.String getGapChar()\r
     {\r
         return this._gapChar;\r
-    } //-- java.lang.String getGapChar() \r
+    }\r
+\r
+    //-- java.lang.String getGapChar() \r
 \r
     /**\r
      * Method getSequence\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @return Sequence\r
      */\r
@@ -245,123 +271,148 @@ public class SequenceSet implements java.io.Serializable {
         throws java.lang.IndexOutOfBoundsException\r
     {\r
         //-- check bounds for index\r
-        if ((index < 0) || (index > _sequenceList.size())) {\r
+        if ((index < 0) || (index > _sequenceList.size()))\r
+        {\r
             throw new IndexOutOfBoundsException();\r
         }\r
-        \r
+\r
         return (jalview.binding.Sequence) _sequenceList.elementAt(index);\r
-    } //-- jalview.binding.Sequence getSequence(int) \r
+    }\r
+\r
+    //-- jalview.binding.Sequence getSequence(int) \r
 \r
     /**\r
      * Method getSequence\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return Sequence\r
      */\r
     public jalview.binding.Sequence[] getSequence()\r
     {\r
         int size = _sequenceList.size();\r
         jalview.binding.Sequence[] mArray = new jalview.binding.Sequence[size];\r
-        for (int index = 0; index < size; index++) {\r
+\r
+        for (int index = 0; index < size; index++)\r
+        {\r
             mArray[index] = (jalview.binding.Sequence) _sequenceList.elementAt(index);\r
         }\r
+\r
         return mArray;\r
-    } //-- jalview.binding.Sequence[] getSequence() \r
+    }\r
+\r
+    //-- jalview.binding.Sequence[] getSequence() \r
 \r
     /**\r
      * Method getSequenceCount\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return int\r
      */\r
     public int getSequenceCount()\r
     {\r
         return _sequenceList.size();\r
-    } //-- int getSequenceCount() \r
+    }\r
+\r
+    //-- int getSequenceCount() \r
 \r
     /**\r
      * Method hasAligned\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return boolean\r
      */\r
     public boolean hasAligned()\r
     {\r
         return this._has_aligned;\r
-    } //-- boolean hasAligned() \r
+    }\r
+\r
+    //-- boolean hasAligned() \r
 \r
     /**\r
      * Method isValid\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return boolean\r
      */\r
     public boolean isValid()\r
     {\r
-        try {\r
+        try\r
+        {\r
             validate();\r
         }\r
-        catch (org.exolab.castor.xml.ValidationException vex) {\r
+        catch (org.exolab.castor.xml.ValidationException vex)\r
+        {\r
             return false;\r
         }\r
+\r
         return true;\r
-    } //-- boolean isValid() \r
+    }\r
+\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
+        throws org.exolab.castor.xml.MarshalException, \r
+            org.exolab.castor.xml.ValidationException\r
     {\r
-        \r
         Marshaller.marshal(this, out);\r
-    } //-- void marshal(java.io.Writer) \r
+    }\r
+\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
+        throws java.io.IOException, org.exolab.castor.xml.MarshalException, \r
+            org.exolab.castor.xml.ValidationException\r
     {\r
-        \r
         Marshaller.marshal(this, handler);\r
-    } //-- void marshal(org.xml.sax.ContentHandler) \r
+    }\r
+\r
+    //-- void marshal(org.xml.sax.ContentHandler) \r
 \r
     /**\r
      * Method removeAllAnnotation\r
-     * \r
+     *\r
      */\r
     public void removeAllAnnotation()\r
     {\r
         _annotationList.removeAllElements();\r
-    } //-- void removeAllAnnotation() \r
+    }\r
+\r
+    //-- void removeAllAnnotation() \r
 \r
     /**\r
      * Method removeAllSequence\r
-     * \r
+     *\r
      */\r
     public void removeAllSequence()\r
     {\r
         _sequenceList.removeAllElements();\r
-    } //-- void removeAllSequence() \r
+    }\r
+\r
+    //-- void removeAllSequence() \r
 \r
     /**\r
      * Method removeAnnotation\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @return Annotation\r
      */\r
@@ -369,14 +420,17 @@ public class SequenceSet implements java.io.Serializable {
     {\r
         java.lang.Object obj = _annotationList.elementAt(index);\r
         _annotationList.removeElementAt(index);\r
+\r
         return (jalview.binding.Annotation) obj;\r
-    } //-- jalview.binding.Annotation removeAnnotation(int) \r
+    }\r
+\r
+    //-- jalview.binding.Annotation removeAnnotation(int) \r
 \r
     /**\r
      * Method removeSequence\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @return Sequence\r
      */\r
@@ -384,25 +438,30 @@ public class SequenceSet implements java.io.Serializable {
     {\r
         java.lang.Object obj = _sequenceList.elementAt(index);\r
         _sequenceList.removeElementAt(index);\r
+\r
         return (jalview.binding.Sequence) obj;\r
-    } //-- jalview.binding.Sequence removeSequence(int) \r
+    }\r
+\r
+    //-- jalview.binding.Sequence removeSequence(int) \r
 \r
     /**\r
      * Sets the value of field 'aligned'.\r
-     * \r
+     *\r
      * @param aligned the value of field 'aligned'.\r
      */\r
     public void setAligned(boolean aligned)\r
     {\r
         this._aligned = aligned;\r
         this._has_aligned = true;\r
-    } //-- void setAligned(boolean) \r
+    }\r
+\r
+    //-- void setAligned(boolean) \r
 \r
     /**\r
      * Method setAnnotation\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @param vAnnotation\r
      */\r
@@ -410,43 +469,53 @@ public class SequenceSet implements java.io.Serializable {
         throws java.lang.IndexOutOfBoundsException\r
     {\r
         //-- check bounds for index\r
-        if ((index < 0) || (index > _annotationList.size())) {\r
+        if ((index < 0) || (index > _annotationList.size()))\r
+        {\r
             throw new IndexOutOfBoundsException();\r
         }\r
+\r
         _annotationList.setElementAt(vAnnotation, index);\r
-    } //-- void setAnnotation(int, jalview.binding.Annotation) \r
+    }\r
+\r
+    //-- void setAnnotation(int, jalview.binding.Annotation) \r
 \r
     /**\r
      * Method setAnnotation\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param annotationArray\r
      */\r
     public void setAnnotation(jalview.binding.Annotation[] annotationArray)\r
     {\r
         //-- copy array\r
         _annotationList.removeAllElements();\r
-        for (int i = 0; i < annotationArray.length; i++) {\r
+\r
+        for (int i = 0; i < annotationArray.length; i++)\r
+        {\r
             _annotationList.addElement(annotationArray[i]);\r
         }\r
-    } //-- void setAnnotation(jalview.binding.Annotation) \r
+    }\r
+\r
+    //-- void setAnnotation(jalview.binding.Annotation) \r
 \r
     /**\r
      * Sets the value of field 'gapChar'.\r
-     * \r
+     *\r
      * @param gapChar the value of field 'gapChar'.\r
      */\r
     public void setGapChar(java.lang.String gapChar)\r
     {\r
         this._gapChar = gapChar;\r
-    } //-- void setGapChar(java.lang.String) \r
+    }\r
+\r
+    //-- void setGapChar(java.lang.String) \r
 \r
     /**\r
      * Method setSequence\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @param vSequence\r
      */\r
@@ -454,51 +523,63 @@ public class SequenceSet implements java.io.Serializable {
         throws java.lang.IndexOutOfBoundsException\r
     {\r
         //-- check bounds for index\r
-        if ((index < 0) || (index > _sequenceList.size())) {\r
+        if ((index < 0) || (index > _sequenceList.size()))\r
+        {\r
             throw new IndexOutOfBoundsException();\r
         }\r
+\r
         _sequenceList.setElementAt(vSequence, index);\r
-    } //-- void setSequence(int, jalview.binding.Sequence) \r
+    }\r
+\r
+    //-- void setSequence(int, jalview.binding.Sequence) \r
 \r
     /**\r
      * Method setSequence\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param sequenceArray\r
      */\r
     public void setSequence(jalview.binding.Sequence[] sequenceArray)\r
     {\r
         //-- copy array\r
         _sequenceList.removeAllElements();\r
-        for (int i = 0; i < sequenceArray.length; i++) {\r
+\r
+        for (int i = 0; i < sequenceArray.length; i++)\r
+        {\r
             _sequenceList.addElement(sequenceArray[i]);\r
         }\r
-    } //-- void setSequence(jalview.binding.Sequence) \r
+    }\r
+\r
+    //-- void setSequence(jalview.binding.Sequence) \r
 \r
     /**\r
      * Method unmarshal\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param reader\r
      * @return Object\r
      */\r
     public static java.lang.Object unmarshal(java.io.Reader reader)\r
-        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
+        throws org.exolab.castor.xml.MarshalException, \r
+            org.exolab.castor.xml.ValidationException\r
     {\r
-        return (jalview.binding.SequenceSet) Unmarshaller.unmarshal(jalview.binding.SequenceSet.class, reader);\r
-    } //-- java.lang.Object unmarshal(java.io.Reader) \r
+        return (jalview.binding.SequenceSet) Unmarshaller.unmarshal(jalview.binding.SequenceSet.class,\r
+            reader);\r
+    }\r
+\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
+    public void validate() 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
+    }\r
 \r
+    //-- void validate() \r
 }\r