Jalview 2.6 source licence
[jalview.git] / src / jalview / schemabinding / version2 / SequenceSet.java
index 3179078..bd5efa9 100755 (executable)
@@ -1,26 +1,25 @@
 /*\r
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)\r
- * Copyright (C) 2008 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)\r
+ * Copyright (C) 2010 J Procter, AM Waterhouse, 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
+ * This file is part of Jalview.\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
+ * Jalview 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 3 of the License, or (at your option) any later version.\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
+ * Jalview is distributed in the hope that it will be useful, but \r
+ * WITHOUT ANY WARRANTY; without even the implied warranty \r
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR \r
+ * PURPOSE.  See the GNU General Public License for more details.\r
+ * \r
+ * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.\r
  */\r
 package jalview.schemabinding.version2;\r
 \r
-// ---------------------------------/\r
-// - Imported classes and packages -/\r
-// ---------------------------------/\r
+//---------------------------------/\r
+//- Imported classes and packages -/\r
+//---------------------------------/\r
 \r
 import org.exolab.castor.xml.Marshaller;\r
 import org.exolab.castor.xml.Unmarshaller;\r
@@ -91,7 +90,7 @@ public class SequenceSet implements java.io.Serializable
    * \r
    * @param vAlcodonFrame\r
    * @throws java.lang.IndexOutOfBoundsException\r
-   *                 if the index given is outside the bounds of the collection\r
+   *           if the index given is outside the bounds of the collection\r
    */\r
   public void addAlcodonFrame(\r
           final jalview.schemabinding.version2.AlcodonFrame vAlcodonFrame)\r
@@ -106,7 +105,7 @@ public class SequenceSet implements java.io.Serializable
    * @param index\r
    * @param vAlcodonFrame\r
    * @throws java.lang.IndexOutOfBoundsException\r
-   *                 if the index given is outside the bounds of the collection\r
+   *           if the index given is outside the bounds of the collection\r
    */\r
   public void addAlcodonFrame(final int index,\r
           final jalview.schemabinding.version2.AlcodonFrame vAlcodonFrame)\r
@@ -120,7 +119,7 @@ public class SequenceSet implements java.io.Serializable
    * \r
    * @param vAnnotation\r
    * @throws java.lang.IndexOutOfBoundsException\r
-   *                 if the index given is outside the bounds of the collection\r
+   *           if the index given is outside the bounds of the collection\r
    */\r
   public void addAnnotation(\r
           final jalview.schemabinding.version2.Annotation vAnnotation)\r
@@ -135,7 +134,7 @@ public class SequenceSet implements java.io.Serializable
    * @param index\r
    * @param vAnnotation\r
    * @throws java.lang.IndexOutOfBoundsException\r
-   *                 if the index given is outside the bounds of the collection\r
+   *           if the index given is outside the bounds of the collection\r
    */\r
   public void addAnnotation(final int index,\r
           final jalview.schemabinding.version2.Annotation vAnnotation)\r
@@ -149,7 +148,7 @@ public class SequenceSet implements java.io.Serializable
    * \r
    * @param vSequence\r
    * @throws java.lang.IndexOutOfBoundsException\r
-   *                 if the index given is outside the bounds of the collection\r
+   *           if the index given is outside the bounds of the collection\r
    */\r
   public void addSequence(\r
           final jalview.schemabinding.version2.Sequence vSequence)\r
@@ -164,7 +163,7 @@ public class SequenceSet implements java.io.Serializable
    * @param index\r
    * @param vSequence\r
    * @throws java.lang.IndexOutOfBoundsException\r
-   *                 if the index given is outside the bounds of the collection\r
+   *           if the index given is outside the bounds of the collection\r
    */\r
   public void addSequence(final int index,\r
           final jalview.schemabinding.version2.Sequence vSequence)\r
@@ -178,7 +177,7 @@ public class SequenceSet implements java.io.Serializable
    * \r
    * @param vSequenceSetProperties\r
    * @throws java.lang.IndexOutOfBoundsException\r
-   *                 if the index given is outside the bounds of the collection\r
+   *           if the index given is outside the bounds of the collection\r
    */\r
   public void addSequenceSetProperties(\r
           final jalview.schemabinding.version2.SequenceSetProperties vSequenceSetProperties)\r
@@ -193,7 +192,7 @@ public class SequenceSet implements java.io.Serializable
    * @param index\r
    * @param vSequenceSetProperties\r
    * @throws java.lang.IndexOutOfBoundsException\r
-   *                 if the index given is outside the bounds of the collection\r
+   *           if the index given is outside the bounds of the collection\r
    */\r
   public void addSequenceSetProperties(\r
           final int index,\r
@@ -252,7 +251,7 @@ public class SequenceSet implements java.io.Serializable
    * \r
    * @param index\r
    * @throws java.lang.IndexOutOfBoundsException\r
-   *                 if the index given is outside the bounds of the collection\r
+   *           if the index given is outside the bounds of the collection\r
    * @return the value of the jalview.schemabinding.version2.AlcodonFrame at the\r
    *         given inde\r
    */\r
@@ -302,7 +301,7 @@ public class SequenceSet implements java.io.Serializable
    * \r
    * @param index\r
    * @throws java.lang.IndexOutOfBoundsException\r
-   *                 if the index given is outside the bounds of the collection\r
+   *           if the index given is outside the bounds of the collection\r
    * @return the value of the jalview.schemabinding.version2.Annotation at the\r
    *         given index\r
    */\r
@@ -375,7 +374,7 @@ public class SequenceSet implements java.io.Serializable
    * \r
    * @param index\r
    * @throws java.lang.IndexOutOfBoundsException\r
-   *                 if the index given is outside the bounds of the collection\r
+   *           if the index given is outside the bounds of the collection\r
    * @return the value of the jalview.schemabinding.version2.Sequence at the\r
    *         given index\r
    */\r
@@ -425,7 +424,7 @@ public class SequenceSet implements java.io.Serializable
    * \r
    * @param index\r
    * @throws java.lang.IndexOutOfBoundsException\r
-   *                 if the index given is outside the bounds of the collection\r
+   *           if the index given is outside the bounds of the collection\r
    * @return the value of the\r
    *         jalview.schemabinding.version2.SequenceSetProperties at the given\r
    *         index\r
@@ -495,11 +494,10 @@ public class SequenceSet implements java.io.Serializable
    * \r
    * @param out\r
    * @throws org.exolab.castor.xml.MarshalException\r
-   *                 if object is null or if any SAXException is thrown during\r
-   *                 marshaling\r
+   *           if object is null or if any SAXException is thrown during\r
+   *           marshaling\r
    * @throws org.exolab.castor.xml.ValidationException\r
-   *                 if this object is an invalid instance according to the\r
-   *                 schema\r
+   *           if this object is an invalid instance according to the schema\r
    */\r
   public void marshal(final java.io.Writer out)\r
           throws org.exolab.castor.xml.MarshalException,\r
@@ -513,13 +511,12 @@ public class SequenceSet implements java.io.Serializable
    * \r
    * @param handler\r
    * @throws java.io.IOException\r
-   *                 if an IOException occurs during marshaling\r
+   *           if an IOException occurs during marshaling\r
    * @throws org.exolab.castor.xml.ValidationException\r
-   *                 if this object is an invalid instance according to the\r
-   *                 schema\r
+   *           if this object is an invalid instance according to the schema\r
    * @throws org.exolab.castor.xml.MarshalException\r
-   *                 if object is null or if any SAXException is thrown during\r
-   *                 marshaling\r
+   *           if object is null or if any SAXException is thrown during\r
+   *           marshaling\r
    */\r
   public void marshal(final org.xml.sax.ContentHandler handler)\r
           throws java.io.IOException,\r
@@ -556,28 +553,28 @@ public class SequenceSet implements java.io.Serializable
   }\r
 \r
   /**\r
-   */\r
+     */\r
   public void removeAllAlcodonFrame()\r
   {\r
     this._alcodonFrameList.clear();\r
   }\r
 \r
   /**\r
-   */\r
+     */\r
   public void removeAllAnnotation()\r
   {\r
     this._annotationList.clear();\r
   }\r
 \r
   /**\r
-   */\r
+     */\r
   public void removeAllSequence()\r
   {\r
     this._sequenceList.clear();\r
   }\r
 \r
   /**\r
-   */\r
+     */\r
   public void removeAllSequenceSetProperties()\r
   {\r
     this._sequenceSetPropertiesList.clear();\r
@@ -668,7 +665,7 @@ public class SequenceSet implements java.io.Serializable
    * @param index\r
    * @param vAlcodonFrame\r
    * @throws java.lang.IndexOutOfBoundsException\r
-   *                 if the index given is outside the bounds of the collection\r
+   *           if the index given is outside the bounds of the collection\r
    */\r
   public void setAlcodonFrame(final int index,\r
           final jalview.schemabinding.version2.AlcodonFrame vAlcodonFrame)\r
@@ -708,7 +705,7 @@ public class SequenceSet implements java.io.Serializable
    * @param index\r
    * @param vAnnotation\r
    * @throws java.lang.IndexOutOfBoundsException\r
-   *                 if the index given is outside the bounds of the collection\r
+   *           if the index given is outside the bounds of the collection\r
    */\r
   public void setAnnotation(final int index,\r
           final jalview.schemabinding.version2.Annotation vAnnotation)\r
@@ -749,7 +746,7 @@ public class SequenceSet implements java.io.Serializable
    * \r
    * \r
    * @param datasetId\r
-   *                the value of field 'datasetId'.\r
+   *          the value of field 'datasetId'.\r
    */\r
   public void setDatasetId(final java.lang.String datasetId)\r
   {\r
@@ -760,7 +757,7 @@ public class SequenceSet implements java.io.Serializable
    * Sets the value of field 'gapChar'.\r
    * \r
    * @param gapChar\r
-   *                the value of field 'gapChar'.\r
+   *          the value of field 'gapChar'.\r
    */\r
   public void setGapChar(final java.lang.String gapChar)\r
   {\r
@@ -773,7 +770,7 @@ public class SequenceSet implements java.io.Serializable
    * @param index\r
    * @param vSequence\r
    * @throws java.lang.IndexOutOfBoundsException\r
-   *                 if the index given is outside the bounds of the collection\r
+   *           if the index given is outside the bounds of the collection\r
    */\r
   public void setSequence(final int index,\r
           final jalview.schemabinding.version2.Sequence vSequence)\r
@@ -813,7 +810,7 @@ public class SequenceSet implements java.io.Serializable
    * @param index\r
    * @param vSequenceSetProperties\r
    * @throws java.lang.IndexOutOfBoundsException\r
-   *                 if the index given is outside the bounds of the collection\r
+   *           if the index given is outside the bounds of the collection\r
    */\r
   public void setSequenceSetProperties(\r
           final int index,\r
@@ -854,11 +851,10 @@ public class SequenceSet implements java.io.Serializable
    * \r
    * @param reader\r
    * @throws org.exolab.castor.xml.MarshalException\r
-   *                 if object is null or if any SAXException is thrown during\r
-   *                 marshaling\r
+   *           if object is null or if any SAXException is thrown during\r
+   *           marshaling\r
    * @throws org.exolab.castor.xml.ValidationException\r
-   *                 if this object is an invalid instance according to the\r
-   *                 schema\r
+   *           if this object is an invalid instance according to the schema\r
    * @return the unmarshaled jalview.schemabinding.version2.SequenceSet\r
    */\r
   public static jalview.schemabinding.version2.SequenceSet unmarshal(\r
@@ -875,8 +871,7 @@ public class SequenceSet implements java.io.Serializable
    * \r
    * \r
    * @throws org.exolab.castor.xml.ValidationException\r
-   *                 if this object is an invalid instance according to the\r
-   *                 schema\r
+   *           if this object is an invalid instance according to the schema\r
    */\r
   public void validate() throws org.exolab.castor.xml.ValidationException\r
   {\r