JAL-1620 version bump and release notes
[jalview.git] / src / jalview / binding / VAMSAS.java
old mode 100755 (executable)
new mode 100644 (file)
index b886fb9..0bb696a
@@ -1,26 +1,30 @@
 /*
- * 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.2b1)
+ * 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
+ * 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 jalview.util.MessageManager;
 
 import org.exolab.castor.xml.Marshaller;
 import org.exolab.castor.xml.Unmarshaller;
@@ -73,7 +77,7 @@ public class VAMSAS implements java.io.Serializable
    * 
    * @param vAlignment
    * @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 addAlignment(final Alignment vAlignment)
           throws java.lang.IndexOutOfBoundsException
@@ -87,7 +91,7 @@ public class VAMSAS implements java.io.Serializable
    * @param index
    * @param vAlignment
    * @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 addAlignment(final int index, final Alignment vAlignment)
           throws java.lang.IndexOutOfBoundsException
@@ -100,7 +104,7 @@ public class VAMSAS implements java.io.Serializable
    * 
    * @param vSequenceSet
    * @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 addSequenceSet(final SequenceSet vSequenceSet)
           throws java.lang.IndexOutOfBoundsException
@@ -114,7 +118,7 @@ public class VAMSAS implements java.io.Serializable
    * @param index
    * @param vSequenceSet
    * @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 addSequenceSet(final int index, final SequenceSet vSequenceSet)
           throws java.lang.IndexOutOfBoundsException
@@ -127,7 +131,7 @@ public class VAMSAS implements java.io.Serializable
    * 
    * @param vTree
    * @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 addTree(final java.lang.String vTree)
           throws java.lang.IndexOutOfBoundsException
@@ -141,7 +145,7 @@ public class VAMSAS implements java.io.Serializable
    * @param index
    * @param vTree
    * @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 addTree(final int index, final java.lang.String vTree)
           throws java.lang.IndexOutOfBoundsException
@@ -184,7 +188,7 @@ public class VAMSAS 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 Alignment at the given index
    */
   public Alignment getAlignment(final int index)
@@ -193,9 +197,11 @@ public class VAMSAS implements java.io.Serializable
     // check bounds for index
     if (index < 0 || index >= this._alignmentList.size())
     {
-      throw new IndexOutOfBoundsException("getAlignment: Index value '"
-              + index + "' not in range [0.."
-              + (this._alignmentList.size() - 1) + "]");
+        throw new IndexOutOfBoundsException(MessageManager.formatMessage("exception.index_value_not_in_range", new String[]{
+                 "getAlignment",
+                 Integer.valueOf(index).toString(),
+                 Integer.valueOf((this._alignmentList.size() - 1)).toString()
+        })); 
     }
 
     return (Alignment) _alignmentList.get(index);
@@ -231,7 +237,7 @@ public class VAMSAS 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 SequenceSet at the given index
    */
   public SequenceSet getSequenceSet(final int index)
@@ -240,9 +246,11 @@ public class VAMSAS implements java.io.Serializable
     // check bounds for index
     if (index < 0 || index >= this._sequenceSetList.size())
     {
-      throw new IndexOutOfBoundsException("getSequenceSet: Index value '"
-              + index + "' not in range [0.."
-              + (this._sequenceSetList.size() - 1) + "]");
+        throw new IndexOutOfBoundsException(MessageManager.formatMessage("exception.index_value_not_in_range", new String[]{
+                         "getSequenceSet",
+                         Integer.valueOf(index).toString(),
+                         Integer.valueOf((this._sequenceSetList.size() - 1)).toString()
+          })); 
     }
 
     return (SequenceSet) _sequenceSetList.get(index);
@@ -278,7 +286,7 @@ public class VAMSAS 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 java.lang.String at the given index
    */
   public java.lang.String getTree(final int index)
@@ -287,8 +295,11 @@ public class VAMSAS implements java.io.Serializable
     // check bounds for index
     if (index < 0 || index >= this._treeList.size())
     {
-      throw new IndexOutOfBoundsException("getTree: Index value '" + index
-              + "' not in range [0.." + (this._treeList.size() - 1) + "]");
+        throw new IndexOutOfBoundsException(MessageManager.formatMessage("exception.index_value_not_in_range", new String[]{
+                 "getTree",
+                 Integer.valueOf(index).toString(),
+                 Integer.valueOf((this._treeList.size() - 1)).toString()
+        })); 
     }
 
     return (java.lang.String) _treeList.get(index);
@@ -341,11 +352,10 @@ public class VAMSAS 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,
@@ -359,13 +369,12 @@ public class VAMSAS 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,
@@ -400,21 +409,21 @@ public class VAMSAS implements java.io.Serializable
   }
 
   /**
-   */
+     */
   public void removeAllAlignment()
   {
     this._alignmentList.clear();
   }
 
   /**
-   */
+     */
   public void removeAllSequenceSet()
   {
     this._sequenceSetList.clear();
   }
 
   /**
-   */
+     */
   public void removeAllTree()
   {
     this._treeList.clear();
@@ -474,7 +483,7 @@ public class VAMSAS implements java.io.Serializable
    * @param index
    * @param vAlignment
    * @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 setAlignment(final int index, final Alignment vAlignment)
           throws java.lang.IndexOutOfBoundsException
@@ -482,9 +491,11 @@ public class VAMSAS implements java.io.Serializable
     // check bounds for index
     if (index < 0 || index >= this._alignmentList.size())
     {
-      throw new IndexOutOfBoundsException("setAlignment: Index value '"
-              + index + "' not in range [0.."
-              + (this._alignmentList.size() - 1) + "]");
+        throw new IndexOutOfBoundsException(MessageManager.formatMessage("exception.index_value_not_in_range", new String[]{
+                         "setAlignment",
+                         Integer.valueOf(index).toString(),
+                         Integer.valueOf((this._alignmentList.size() - 1)).toString()
+          })); 
     }
 
     this._alignmentList.set(index, vAlignment);
@@ -512,7 +523,7 @@ public class VAMSAS implements java.io.Serializable
    * @param index
    * @param vSequenceSet
    * @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 setSequenceSet(final int index, final SequenceSet vSequenceSet)
           throws java.lang.IndexOutOfBoundsException
@@ -520,9 +531,11 @@ public class VAMSAS implements java.io.Serializable
     // check bounds for index
     if (index < 0 || index >= this._sequenceSetList.size())
     {
-      throw new IndexOutOfBoundsException("setSequenceSet: Index value '"
-              + index + "' not in range [0.."
-              + (this._sequenceSetList.size() - 1) + "]");
+        throw new IndexOutOfBoundsException(MessageManager.formatMessage("exception.index_value_not_in_range", new String[]{
+                 "setSequenceSet",
+                 Integer.valueOf(index).toString(),
+                 Integer.valueOf((this._sequenceSetList.size() - 1)).toString()
+        })); 
     }
 
     this._sequenceSetList.set(index, vSequenceSet);
@@ -550,7 +563,7 @@ public class VAMSAS implements java.io.Serializable
    * @param index
    * @param vTree
    * @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 setTree(final int index, final java.lang.String vTree)
           throws java.lang.IndexOutOfBoundsException
@@ -558,8 +571,11 @@ public class VAMSAS implements java.io.Serializable
     // check bounds for index
     if (index < 0 || index >= this._treeList.size())
     {
-      throw new IndexOutOfBoundsException("setTree: Index value '" + index
-              + "' not in range [0.." + (this._treeList.size() - 1) + "]");
+        throw new IndexOutOfBoundsException(MessageManager.formatMessage("exception.index_value_not_in_range", new String[]{
+                         "setTree",
+                         Integer.valueOf(index).toString(),
+                         Integer.valueOf((this._treeList.size() - 1)).toString()
+          })); 
     }
 
     this._treeList.set(index, vTree);
@@ -586,11 +602,10 @@ public class VAMSAS 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.VAMSAS
    */
   public static jalview.binding.VAMSAS unmarshal(final java.io.Reader reader)
@@ -605,8 +620,7 @@ public class VAMSAS 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
   {