modified castor-1.1 library and refactored uk.ac.vamsas
[jalview.git] / src / jalview / schemabinding / version2 / Feature.java
index 305e287..109ec6e 100755 (executable)
@@ -1,6 +1,6 @@
 /*\r
  * This class was automatically generated with \r
- * <a href="http://www.castor.org">Castor 0.9.6</a>, using an XML\r
+ * <a href="http://www.castor.org">Castor 1.1</a>, using an XML\r
  * Schema.\r
  * $Id$\r
  */\r
@@ -11,17 +11,8 @@ package jalview.schemabinding.version2;
  //- Imported classes and packages -/\r
 //---------------------------------/\r
 \r
-import java.io.IOException;\r
-import java.io.Reader;\r
-import java.io.Serializable;\r
-import java.io.Writer;\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
  * Class Feature.\r
@@ -36,7 +27,7 @@ public class Feature implements java.io.Serializable {
     //--------------------------/\r
 \r
     /**\r
-     * Field _begin\r
+     * Field _begin.\r
      */\r
     private int _begin;\r
 \r
@@ -46,7 +37,7 @@ public class Feature implements java.io.Serializable {
     private boolean _has_begin;\r
 \r
     /**\r
-     * Field _end\r
+     * Field _end.\r
      */\r
     private int _end;\r
 \r
@@ -56,27 +47,27 @@ public class Feature implements java.io.Serializable {
     private boolean _has_end;\r
 \r
     /**\r
-     * Field _type\r
+     * Field _type.\r
      */\r
     private java.lang.String _type;\r
 \r
     /**\r
-     * Field _description\r
+     * Field _description.\r
      */\r
     private java.lang.String _description;\r
 \r
     /**\r
-     * Field _status\r
+     * Field _status.\r
      */\r
     private java.lang.String _status;\r
 \r
     /**\r
-     * Field _featureGroup\r
+     * Field _featureGroup.\r
      */\r
     private java.lang.String _featureGroup;\r
 \r
     /**\r
-     * Field _score\r
+     * Field _score.\r
      */\r
     private float _score;\r
 \r
@@ -86,7 +77,7 @@ public class Feature implements java.io.Serializable {
     private boolean _has_score;\r
 \r
     /**\r
-     * Field _otherDataList\r
+     * Field _otherDataList.\r
      */\r
     private java.util.Vector _otherDataList;\r
 \r
@@ -97,8 +88,8 @@ public class Feature implements java.io.Serializable {
 \r
     public Feature() {\r
         super();\r
-        _otherDataList = new Vector();\r
-    } //-- jalview.schemabinding.version2.Feature()\r
+        this._otherDataList = new java.util.Vector();\r
+    }\r
 \r
 \r
       //-----------/\r
@@ -106,432 +97,423 @@ public class Feature implements java.io.Serializable {
     //-----------/\r
 \r
     /**\r
-     * Method addOtherData\r
-     * \r
      * \r
      * \r
      * @param vOtherData\r
+     * @throws java.lang.IndexOutOfBoundsException if the index\r
+     * given is outside the bounds of the collection\r
      */\r
-    public void addOtherData(jalview.schemabinding.version2.OtherData vOtherData)\r
-        throws java.lang.IndexOutOfBoundsException\r
-    {\r
-        _otherDataList.addElement(vOtherData);\r
-    } //-- void addOtherData(jalview.schemabinding.version2.OtherData) \r
+    public void addOtherData(\r
+            final jalview.schemabinding.version2.OtherData vOtherData)\r
+    throws java.lang.IndexOutOfBoundsException {\r
+        this._otherDataList.addElement(vOtherData);\r
+    }\r
 \r
     /**\r
-     * Method addOtherData\r
-     * \r
      * \r
      * \r
      * @param index\r
      * @param vOtherData\r
+     * @throws java.lang.IndexOutOfBoundsException if the index\r
+     * given is outside the bounds of the collection\r
      */\r
-    public void addOtherData(int index, jalview.schemabinding.version2.OtherData vOtherData)\r
-        throws java.lang.IndexOutOfBoundsException\r
-    {\r
-        _otherDataList.insertElementAt(vOtherData, index);\r
-    } //-- void addOtherData(int, jalview.schemabinding.version2.OtherData) \r
+    public void addOtherData(\r
+            final int index,\r
+            final jalview.schemabinding.version2.OtherData vOtherData)\r
+    throws java.lang.IndexOutOfBoundsException {\r
+        this._otherDataList.add(index, vOtherData);\r
+    }\r
 \r
     /**\r
-     * Method deleteBegin\r
-     * \r
      */\r
-    public void deleteBegin()\r
-    {\r
+    public void deleteBegin(\r
+    ) {\r
         this._has_begin= false;\r
-    } //-- void deleteBegin() \r
+    }\r
 \r
     /**\r
-     * Method deleteEnd\r
-     * \r
      */\r
-    public void deleteEnd()\r
-    {\r
+    public void deleteEnd(\r
+    ) {\r
         this._has_end= false;\r
-    } //-- void deleteEnd() \r
+    }\r
 \r
     /**\r
-     * Method deleteScore\r
-     * \r
      */\r
-    public void deleteScore()\r
-    {\r
+    public void deleteScore(\r
+    ) {\r
         this._has_score= false;\r
-    } //-- void deleteScore() \r
+    }\r
 \r
     /**\r
-     * Method enumerateOtherData\r
-     * \r
+     * Method enumerateOtherData.\r
      * \r
-     * \r
-     * @return Enumeration\r
+     * @return an Enumeration over all\r
+     * jalview.schemabinding.version2.OtherData elements\r
      */\r
-    public java.util.Enumeration enumerateOtherData()\r
-    {\r
-        return _otherDataList.elements();\r
-    } //-- java.util.Enumeration enumerateOtherData() \r
+    public java.util.Enumeration enumerateOtherData(\r
+    ) {\r
+        return this._otherDataList.elements();\r
+    }\r
 \r
     /**\r
      * Returns the value of field 'begin'.\r
      * \r
-     * @return int\r
-     * @return the value of field 'begin'.\r
+     * @return the value of field 'Begin'.\r
      */\r
-    public int getBegin()\r
-    {\r
+    public int getBegin(\r
+    ) {\r
         return this._begin;\r
-    } //-- int getBegin() \r
+    }\r
 \r
     /**\r
      * Returns the value of field 'description'.\r
      * \r
-     * @return String\r
-     * @return the value of field 'description'.\r
+     * @return the value of field 'Description'.\r
      */\r
-    public java.lang.String getDescription()\r
-    {\r
+    public java.lang.String getDescription(\r
+    ) {\r
         return this._description;\r
-    } //-- java.lang.String getDescription() \r
+    }\r
 \r
     /**\r
      * Returns the value of field 'end'.\r
      * \r
-     * @return int\r
-     * @return the value of field 'end'.\r
+     * @return the value of field 'End'.\r
      */\r
-    public int getEnd()\r
-    {\r
+    public int getEnd(\r
+    ) {\r
         return this._end;\r
-    } //-- int getEnd() \r
+    }\r
 \r
     /**\r
      * Returns the value of field 'featureGroup'.\r
      * \r
-     * @return String\r
-     * @return the value of field 'featureGroup'.\r
+     * @return the value of field 'FeatureGroup'.\r
      */\r
-    public java.lang.String getFeatureGroup()\r
-    {\r
+    public java.lang.String getFeatureGroup(\r
+    ) {\r
         return this._featureGroup;\r
-    } //-- java.lang.String getFeatureGroup() \r
+    }\r
 \r
     /**\r
-     * Method getOtherData\r
-     * \r
-     * \r
+     * Method getOtherData.\r
      * \r
      * @param index\r
-     * @return OtherData\r
-     */\r
-    public jalview.schemabinding.version2.OtherData getOtherData(int index)\r
-        throws java.lang.IndexOutOfBoundsException\r
-    {\r
-        //-- check bounds for index\r
-        if ((index < 0) || (index > _otherDataList.size())) {\r
-            throw new IndexOutOfBoundsException();\r
+     * @throws java.lang.IndexOutOfBoundsException if the index\r
+     * given is outside the bounds of the collection\r
+     * @return the value of the\r
+     * jalview.schemabinding.version2.OtherData at the given index\r
+     */\r
+    public jalview.schemabinding.version2.OtherData getOtherData(\r
+            final int index)\r
+    throws java.lang.IndexOutOfBoundsException {\r
+        // check bounds for index\r
+        if (index < 0 || index >= this._otherDataList.size()) {\r
+            throw new IndexOutOfBoundsException("getOtherData: Index value '" + index + "' not in range [0.." + (this._otherDataList.size() - 1) + "]");\r
         }\r
         \r
-        return (jalview.schemabinding.version2.OtherData) _otherDataList.elementAt(index);\r
-    } //-- jalview.schemabinding.version2.OtherData getOtherData(int) \r
+        return (jalview.schemabinding.version2.OtherData) _otherDataList.get(index);\r
+    }\r
 \r
     /**\r
-     * Method getOtherData\r
-     * \r
-     * \r
+     * Method getOtherData.Returns the contents of the collection\r
+     * in an Array.  <p>Note:  Just in case the collection contents\r
+     * are changing in another thread, we pass a 0-length Array of\r
+     * the correct type into the API call.  This way we <i>know</i>\r
+     * that the Array returned is of exactly the correct length.\r
      * \r
-     * @return OtherData\r
+     * @return this collection as an Array\r
      */\r
-    public jalview.schemabinding.version2.OtherData[] getOtherData()\r
-    {\r
-        int size = _otherDataList.size();\r
-        jalview.schemabinding.version2.OtherData[] mArray = new jalview.schemabinding.version2.OtherData[size];\r
-        for (int index = 0; index < size; index++) {\r
-            mArray[index] = (jalview.schemabinding.version2.OtherData) _otherDataList.elementAt(index);\r
-        }\r
-        return mArray;\r
-    } //-- jalview.schemabinding.version2.OtherData[] getOtherData() \r
+    public jalview.schemabinding.version2.OtherData[] getOtherData(\r
+    ) {\r
+        jalview.schemabinding.version2.OtherData[] array = new jalview.schemabinding.version2.OtherData[0];\r
+        return (jalview.schemabinding.version2.OtherData[]) this._otherDataList.toArray(array);\r
+    }\r
 \r
     /**\r
-     * Method getOtherDataCount\r
-     * \r
-     * \r
+     * Method getOtherDataCount.\r
      * \r
-     * @return int\r
+     * @return the size of this collection\r
      */\r
-    public int getOtherDataCount()\r
-    {\r
-        return _otherDataList.size();\r
-    } //-- int getOtherDataCount() \r
+    public int getOtherDataCount(\r
+    ) {\r
+        return this._otherDataList.size();\r
+    }\r
 \r
     /**\r
      * Returns the value of field 'score'.\r
      * \r
-     * @return float\r
-     * @return the value of field 'score'.\r
+     * @return the value of field 'Score'.\r
      */\r
-    public float getScore()\r
-    {\r
+    public float getScore(\r
+    ) {\r
         return this._score;\r
-    } //-- float getScore() \r
+    }\r
 \r
     /**\r
      * Returns the value of field 'status'.\r
      * \r
-     * @return String\r
-     * @return the value of field 'status'.\r
+     * @return the value of field 'Status'.\r
      */\r
-    public java.lang.String getStatus()\r
-    {\r
+    public java.lang.String getStatus(\r
+    ) {\r
         return this._status;\r
-    } //-- java.lang.String getStatus() \r
+    }\r
 \r
     /**\r
      * Returns the value of field 'type'.\r
      * \r
-     * @return String\r
-     * @return the value of field 'type'.\r
+     * @return the value of field 'Type'.\r
      */\r
-    public java.lang.String getType()\r
-    {\r
+    public java.lang.String getType(\r
+    ) {\r
         return this._type;\r
-    } //-- java.lang.String getType() \r
+    }\r
 \r
     /**\r
-     * Method hasBegin\r
+     * Method hasBegin.\r
      * \r
-     * \r
-     * \r
-     * @return boolean\r
+     * @return true if at least one Begin has been added\r
      */\r
-    public boolean hasBegin()\r
-    {\r
+    public boolean hasBegin(\r
+    ) {\r
         return this._has_begin;\r
-    } //-- boolean hasBegin() \r
+    }\r
 \r
     /**\r
-     * Method hasEnd\r
-     * \r
+     * Method hasEnd.\r
      * \r
-     * \r
-     * @return boolean\r
+     * @return true if at least one End has been added\r
      */\r
-    public boolean hasEnd()\r
-    {\r
+    public boolean hasEnd(\r
+    ) {\r
         return this._has_end;\r
-    } //-- boolean hasEnd() \r
+    }\r
 \r
     /**\r
-     * Method hasScore\r
-     * \r
-     * \r
+     * Method hasScore.\r
      * \r
-     * @return boolean\r
+     * @return true if at least one Score has been added\r
      */\r
-    public boolean hasScore()\r
-    {\r
+    public boolean hasScore(\r
+    ) {\r
         return this._has_score;\r
-    } //-- boolean hasScore() \r
+    }\r
 \r
     /**\r
-     * Method isValid\r
-     * \r
-     * \r
+     * Method isValid.\r
      * \r
-     * @return boolean\r
+     * @return true if this object is valid according to the schema\r
      */\r
-    public boolean isValid()\r
-    {\r
+    public boolean isValid(\r
+    ) {\r
         try {\r
             validate();\r
-        }\r
-        catch (org.exolab.castor.xml.ValidationException vex) {\r
+        } catch (org.exolab.castor.xml.ValidationException vex) {\r
             return false;\r
         }\r
         return true;\r
-    } //-- boolean isValid() \r
+    }\r
 \r
     /**\r
-     * Method marshal\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
+     * @throws org.exolab.castor.xml.MarshalException if object is\r
+     * null or if any SAXException is thrown during marshaling\r
+     * @throws org.exolab.castor.xml.ValidationException if this\r
+     * object is an invalid instance according to the schema\r
+     */\r
+    public void marshal(\r
+            final java.io.Writer out)\r
+    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
         Marshaller.marshal(this, out);\r
-    } //-- void marshal(java.io.Writer) \r
+    }\r
 \r
     /**\r
-     * Method marshal\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
+     * @throws java.io.IOException if an IOException occurs during\r
+     * marshaling\r
+     * @throws org.exolab.castor.xml.ValidationException if this\r
+     * object is an invalid instance according to the schema\r
+     * @throws org.exolab.castor.xml.MarshalException if object is\r
+     * null or if any SAXException is thrown during marshaling\r
+     */\r
+    public void marshal(\r
+            final org.xml.sax.ContentHandler handler)\r
+    throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
         Marshaller.marshal(this, handler);\r
-    } //-- void marshal(org.xml.sax.ContentHandler) \r
+    }\r
 \r
     /**\r
-     * Method removeAllOtherData\r
-     * \r
      */\r
-    public void removeAllOtherData()\r
-    {\r
-        _otherDataList.removeAllElements();\r
-    } //-- void removeAllOtherData() \r
+    public void removeAllOtherData(\r
+    ) {\r
+        this._otherDataList.clear();\r
+    }\r
 \r
     /**\r
-     * Method removeOtherData\r
-     * \r
+     * Method removeOtherData.\r
      * \r
+     * @param vOtherData\r
+     * @return true if the object was removed from the collection.\r
+     */\r
+    public boolean removeOtherData(\r
+            final jalview.schemabinding.version2.OtherData vOtherData) {\r
+        boolean removed = _otherDataList.remove(vOtherData);\r
+        return removed;\r
+    }\r
+\r
+    /**\r
+     * Method removeOtherDataAt.\r
      * \r
      * @param index\r
-     * @return OtherData\r
+     * @return the element removed from the collection\r
      */\r
-    public jalview.schemabinding.version2.OtherData removeOtherData(int index)\r
-    {\r
-        java.lang.Object obj = _otherDataList.elementAt(index);\r
-        _otherDataList.removeElementAt(index);\r
+    public jalview.schemabinding.version2.OtherData removeOtherDataAt(\r
+            final int index) {\r
+        java.lang.Object obj = this._otherDataList.remove(index);\r
         return (jalview.schemabinding.version2.OtherData) obj;\r
-    } //-- jalview.schemabinding.version2.OtherData removeOtherData(int) \r
+    }\r
 \r
     /**\r
      * Sets the value of field 'begin'.\r
      * \r
      * @param begin the value of field 'begin'.\r
      */\r
-    public void setBegin(int begin)\r
-    {\r
+    public void setBegin(\r
+            final int begin) {\r
         this._begin = begin;\r
         this._has_begin = true;\r
-    } //-- void setBegin(int) \r
+    }\r
 \r
     /**\r
      * Sets the value of field 'description'.\r
      * \r
      * @param description the value of field 'description'.\r
      */\r
-    public void setDescription(java.lang.String description)\r
-    {\r
+    public void setDescription(\r
+            final java.lang.String description) {\r
         this._description = description;\r
-    } //-- void setDescription(java.lang.String) \r
+    }\r
 \r
     /**\r
      * Sets the value of field 'end'.\r
      * \r
      * @param end the value of field 'end'.\r
      */\r
-    public void setEnd(int end)\r
-    {\r
+    public void setEnd(\r
+            final int end) {\r
         this._end = end;\r
         this._has_end = true;\r
-    } //-- void setEnd(int) \r
+    }\r
 \r
     /**\r
      * Sets the value of field 'featureGroup'.\r
      * \r
      * @param featureGroup the value of field 'featureGroup'.\r
      */\r
-    public void setFeatureGroup(java.lang.String featureGroup)\r
-    {\r
+    public void setFeatureGroup(\r
+            final java.lang.String featureGroup) {\r
         this._featureGroup = featureGroup;\r
-    } //-- void setFeatureGroup(java.lang.String) \r
+    }\r
 \r
     /**\r
-     * Method setOtherData\r
-     * \r
      * \r
      * \r
      * @param index\r
      * @param vOtherData\r
-     */\r
-    public void setOtherData(int index, jalview.schemabinding.version2.OtherData vOtherData)\r
-        throws java.lang.IndexOutOfBoundsException\r
-    {\r
-        //-- check bounds for index\r
-        if ((index < 0) || (index > _otherDataList.size())) {\r
-            throw new IndexOutOfBoundsException();\r
+     * @throws java.lang.IndexOutOfBoundsException if the index\r
+     * given is outside the bounds of the collection\r
+     */\r
+    public void setOtherData(\r
+            final int index,\r
+            final jalview.schemabinding.version2.OtherData vOtherData)\r
+    throws java.lang.IndexOutOfBoundsException {\r
+        // check bounds for index\r
+        if (index < 0 || index >= this._otherDataList.size()) {\r
+            throw new IndexOutOfBoundsException("setOtherData: Index value '" + index + "' not in range [0.." + (this._otherDataList.size() - 1) + "]");\r
         }\r
-        _otherDataList.setElementAt(vOtherData, index);\r
-    } //-- void setOtherData(int, jalview.schemabinding.version2.OtherData) \r
+        \r
+        this._otherDataList.set(index, vOtherData);\r
+    }\r
 \r
     /**\r
-     * Method setOtherData\r
-     * \r
      * \r
      * \r
-     * @param otherDataArray\r
+     * @param vOtherDataArray\r
      */\r
-    public void setOtherData(jalview.schemabinding.version2.OtherData[] otherDataArray)\r
-    {\r
+    public void setOtherData(\r
+            final jalview.schemabinding.version2.OtherData[] vOtherDataArray) {\r
         //-- copy array\r
-        _otherDataList.removeAllElements();\r
-        for (int i = 0; i < otherDataArray.length; i++) {\r
-            _otherDataList.addElement(otherDataArray[i]);\r
+        _otherDataList.clear();\r
+        \r
+        for (int i = 0; i < vOtherDataArray.length; i++) {\r
+                this._otherDataList.add(vOtherDataArray[i]);\r
         }\r
-    } //-- void setOtherData(jalview.schemabinding.version2.OtherData) \r
+    }\r
 \r
     /**\r
      * Sets the value of field 'score'.\r
      * \r
      * @param score the value of field 'score'.\r
      */\r
-    public void setScore(float score)\r
-    {\r
+    public void setScore(\r
+            final float score) {\r
         this._score = score;\r
         this._has_score = true;\r
-    } //-- void setScore(float) \r
+    }\r
 \r
     /**\r
      * Sets the value of field 'status'.\r
      * \r
      * @param status the value of field 'status'.\r
      */\r
-    public void setStatus(java.lang.String status)\r
-    {\r
+    public void setStatus(\r
+            final java.lang.String status) {\r
         this._status = status;\r
-    } //-- void setStatus(java.lang.String) \r
+    }\r
 \r
     /**\r
      * Sets the value of field 'type'.\r
      * \r
      * @param type the value of field 'type'.\r
      */\r
-    public void setType(java.lang.String type)\r
-    {\r
+    public void setType(\r
+            final java.lang.String type) {\r
         this._type = type;\r
-    } //-- void setType(java.lang.String) \r
+    }\r
 \r
     /**\r
-     * Method unmarshal\r
-     * \r
-     * \r
+     * Method unmarshal.\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
-    {\r
+     * @throws org.exolab.castor.xml.MarshalException if object is\r
+     * null or if any SAXException is thrown during marshaling\r
+     * @throws org.exolab.castor.xml.ValidationException if this\r
+     * object is an invalid instance according to the schema\r
+     * @return the unmarshaled jalview.schemabinding.version2.Featur\r
+     */\r
+    public static jalview.schemabinding.version2.Feature unmarshal(\r
+            final java.io.Reader reader)\r
+    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
         return (jalview.schemabinding.version2.Feature) Unmarshaller.unmarshal(jalview.schemabinding.version2.Feature.class, reader);\r
-    } //-- java.lang.Object unmarshal(java.io.Reader) \r
+    }\r
 \r
     /**\r
-     * Method validate\r
      * \r
+     * \r
+     * @throws org.exolab.castor.xml.ValidationException if this\r
+     * object is an invalid instance according to the schema\r
      */\r
-    public void validate()\r
-        throws org.exolab.castor.xml.ValidationException\r
-    {\r
+    public void validate(\r
+    )\r
+    throws org.exolab.castor.xml.ValidationException {\r
         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
         validator.validate(this);\r
-    } //-- void validate() \r
+    }\r
 \r
 }\r