Merge branch 'docs/2_8_1_Release' into Release_2_8_1_Branch
[jalview.git] / src / jalview / binding / SequenceSet.java
old mode 100755 (executable)
new mode 100644 (file)
index e348f9a..611d49d
@@ -1,26 +1,26 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)
- * Copyright (C) 2008 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1)
+ * Copyright (C) 2014 The Jalview Authors
  * 
- * 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 file is part of Jalview.
  * 
- * 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.
+ * Jalview 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 3 of the License, or (at your option) any later version.
+ *  
+ * Jalview 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
+ * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.binding;
 
-// ---------------------------------/
-// - Imported classes and packages -/
-// ---------------------------------/
+//---------------------------------/
+//- Imported classes and packages -/
+//---------------------------------/
 
 import org.exolab.castor.xml.Marshaller;
 import org.exolab.castor.xml.Unmarshaller;
@@ -82,7 +82,7 @@ public class SequenceSet implements java.io.Serializable
    * 
    * @param vAnnotation
    * @throws java.lang.IndexOutOfBoundsException
-   *                 if the index given is outside the bounds of the collection
+   *           if the index given is outside the bounds of the collection
    */
   public void addAnnotation(final jalview.binding.Annotation vAnnotation)
           throws java.lang.IndexOutOfBoundsException
@@ -96,7 +96,7 @@ public class SequenceSet implements java.io.Serializable
    * @param index
    * @param vAnnotation
    * @throws java.lang.IndexOutOfBoundsException
-   *                 if the index given is outside the bounds of the collection
+   *           if the index given is outside the bounds of the collection
    */
   public void addAnnotation(final int index,
           final jalview.binding.Annotation vAnnotation)
@@ -110,7 +110,7 @@ public class SequenceSet implements java.io.Serializable
    * 
    * @param vSequence
    * @throws java.lang.IndexOutOfBoundsException
-   *                 if the index given is outside the bounds of the collection
+   *           if the index given is outside the bounds of the collection
    */
   public void addSequence(final jalview.binding.Sequence vSequence)
           throws java.lang.IndexOutOfBoundsException
@@ -124,7 +124,7 @@ public class SequenceSet implements java.io.Serializable
    * @param index
    * @param vSequence
    * @throws java.lang.IndexOutOfBoundsException
-   *                 if the index given is outside the bounds of the collection
+   *           if the index given is outside the bounds of the collection
    */
   public void addSequence(final int index,
           final jalview.binding.Sequence vSequence)
@@ -134,7 +134,7 @@ public class SequenceSet implements java.io.Serializable
   }
 
   /**
-   */
+     */
   public void deleteAligned()
   {
     this._has_aligned = false;
@@ -175,7 +175,7 @@ public class SequenceSet implements java.io.Serializable
    * 
    * @param index
    * @throws java.lang.IndexOutOfBoundsException
-   *                 if the index given is outside the bounds of the collection
+   *           if the index given is outside the bounds of the collection
    * @return the value of the jalview.binding.Annotation at the given index
    */
   public jalview.binding.Annotation getAnnotation(final int index)
@@ -233,7 +233,7 @@ public class SequenceSet implements java.io.Serializable
    * 
    * @param index
    * @throws java.lang.IndexOutOfBoundsException
-   *                 if the index given is outside the bounds of the collection
+   *           if the index given is outside the bounds of the collection
    * @return the value of the jalview.binding.Sequence at the given index
    */
   public jalview.binding.Sequence getSequence(final int index)
@@ -317,11 +317,10 @@ public class SequenceSet implements java.io.Serializable
    * 
    * @param out
    * @throws org.exolab.castor.xml.MarshalException
-   *                 if object is null or if any SAXException is thrown during
-   *                 marshaling
+   *           if object is null or if any SAXException is thrown during
+   *           marshaling
    * @throws org.exolab.castor.xml.ValidationException
-   *                 if this object is an invalid instance according to the
-   *                 schema
+   *           if this object is an invalid instance according to the schema
    */
   public void marshal(final java.io.Writer out)
           throws org.exolab.castor.xml.MarshalException,
@@ -335,13 +334,12 @@ public class SequenceSet implements java.io.Serializable
    * 
    * @param handler
    * @throws java.io.IOException
-   *                 if an IOException occurs during marshaling
+   *           if an IOException occurs during marshaling
    * @throws org.exolab.castor.xml.ValidationException
-   *                 if this object is an invalid instance according to the
-   *                 schema
+   *           if this object is an invalid instance according to the schema
    * @throws org.exolab.castor.xml.MarshalException
-   *                 if object is null or if any SAXException is thrown during
-   *                 marshaling
+   *           if object is null or if any SAXException is thrown during
+   *           marshaling
    */
   public void marshal(final org.xml.sax.ContentHandler handler)
           throws java.io.IOException,
@@ -352,14 +350,14 @@ public class SequenceSet implements java.io.Serializable
   }
 
   /**
-   */
+     */
   public void removeAllAnnotation()
   {
     this._annotationList.clear();
   }
 
   /**
-   */
+     */
   public void removeAllSequence()
   {
     this._sequenceList.clear();
@@ -418,7 +416,7 @@ public class SequenceSet implements java.io.Serializable
    * Sets the value of field 'aligned'.
    * 
    * @param aligned
-   *                the value of field 'aligned'.
+   *          the value of field 'aligned'.
    */
   public void setAligned(final boolean aligned)
   {
@@ -432,7 +430,7 @@ public class SequenceSet implements java.io.Serializable
    * @param index
    * @param vAnnotation
    * @throws java.lang.IndexOutOfBoundsException
-   *                 if the index given is outside the bounds of the collection
+   *           if the index given is outside the bounds of the collection
    */
   public void setAnnotation(final int index,
           final jalview.binding.Annotation vAnnotation)
@@ -470,7 +468,7 @@ public class SequenceSet implements java.io.Serializable
    * Sets the value of field 'gapChar'.
    * 
    * @param gapChar
-   *                the value of field 'gapChar'.
+   *          the value of field 'gapChar'.
    */
   public void setGapChar(final java.lang.String gapChar)
   {
@@ -483,7 +481,7 @@ public class SequenceSet implements java.io.Serializable
    * @param index
    * @param vSequence
    * @throws java.lang.IndexOutOfBoundsException
-   *                 if the index given is outside the bounds of the collection
+   *           if the index given is outside the bounds of the collection
    */
   public void setSequence(final int index,
           final jalview.binding.Sequence vSequence)
@@ -521,11 +519,10 @@ public class SequenceSet implements java.io.Serializable
    * 
    * @param reader
    * @throws org.exolab.castor.xml.MarshalException
-   *                 if object is null or if any SAXException is thrown during
-   *                 marshaling
+   *           if object is null or if any SAXException is thrown during
+   *           marshaling
    * @throws org.exolab.castor.xml.ValidationException
-   *                 if this object is an invalid instance according to the
-   *                 schema
+   *           if this object is an invalid instance according to the schema
    * @return the unmarshaled jalview.binding.SequenceSet
    */
   public static jalview.binding.SequenceSet unmarshal(
@@ -541,8 +538,7 @@ public class SequenceSet implements java.io.Serializable
    * 
    * 
    * @throws org.exolab.castor.xml.ValidationException
-   *                 if this object is an invalid instance according to the
-   *                 schema
+   *           if this object is an invalid instance according to the schema
    */
   public void validate() throws org.exolab.castor.xml.ValidationException
   {