refactor
[jalview.git] / src / jalview / schemabinding / version2 / FeatureSettings.java
index 2dad54a..5ce4054 100755 (executable)
 /*\r
- * This class was automatically generated with\r
- * <a href="http://www.castor.org">Castor 0.9.6</a>, using an XML\r
+ * This class was automatically generated with \r
+ * <a href="http://www.castor.org">Castor 1.1</a>, using an XML\r
  * Schema.\r
  * $Id$\r
  */\r
 \r
 package jalview.schemabinding.version2;\r
 \r
+  //---------------------------------/\r
+ //- Imported classes and packages -/\r
 //---------------------------------/\r
-//- Imported classes and packages -/\r
-//---------------------------------/\r
-\r
-import java.util.*;\r
 \r
-import org.exolab.castor.xml.*;\r
+import org.exolab.castor.xml.Marshaller;\r
+import org.exolab.castor.xml.Unmarshaller;\r
 \r
 /**\r
  * Class FeatureSettings.\r
- *\r
+ * \r
  * @version $Revision$ $Date$\r
  */\r
-public class FeatureSettings\r
-    implements java.io.Serializable\r
-{\r
-\r
-  //--------------------------/\r
-  //- Class/Member Variables -/\r
-  //--------------------------/\r
-\r
-  /**\r
-   * Field _settingList\r
-   */\r
-  private java.util.Vector _settingList;\r
-\r
-  //----------------/\r
-  //- Constructors -/\r
-  //----------------/\r
-\r
-  public FeatureSettings()\r
-  {\r
-    super();\r
-    _settingList = new Vector();\r
-  } //-- jalview.schemabinding.version2.FeatureSettings()\r
-\r
-  //-----------/\r
-  //- Methods -/\r
-  //-----------/\r
-\r
-  /**\r
-   * Method addSetting\r
-   *\r
-   *\r
-   *\r
-   * @param vSetting\r
-   */\r
-  public void addSetting(jalview.schemabinding.version2.Setting vSetting)\r
-      throws java.lang.IndexOutOfBoundsException\r
-  {\r
-    _settingList.addElement(vSetting);\r
-  } //-- void addSetting(jalview.schemabinding.version2.Setting)\r
-\r
-  /**\r
-   * Method addSetting\r
-   *\r
-   *\r
-   *\r
-   * @param index\r
-   * @param vSetting\r
-   */\r
-  public void addSetting(int index,\r
-                         jalview.schemabinding.version2.Setting vSetting)\r
-      throws java.lang.IndexOutOfBoundsException\r
-  {\r
-    _settingList.insertElementAt(vSetting, index);\r
-  } //-- void addSetting(int, jalview.schemabinding.version2.Setting)\r
-\r
-  /**\r
-   * Method enumerateSetting\r
-   *\r
-   *\r
-   *\r
-   * @return Enumeration\r
-   */\r
-  public java.util.Enumeration enumerateSetting()\r
-  {\r
-    return _settingList.elements();\r
-  } //-- java.util.Enumeration enumerateSetting()\r
-\r
-  /**\r
-   * Method getSetting\r
-   *\r
-   *\r
-   *\r
-   * @param index\r
-   * @return Setting\r
-   */\r
-  public jalview.schemabinding.version2.Setting getSetting(int index)\r
-      throws java.lang.IndexOutOfBoundsException\r
-  {\r
-    //-- check bounds for index\r
-    if ( (index < 0) || (index > _settingList.size()))\r
-    {\r
-      throw new IndexOutOfBoundsException();\r
+public class FeatureSettings implements java.io.Serializable {\r
+\r
+\r
+      //--------------------------/\r
+     //- Class/Member Variables -/\r
+    //--------------------------/\r
+\r
+    /**\r
+     * Field _settingList.\r
+     */\r
+    private java.util.Vector _settingList;\r
+\r
+    /**\r
+     * Field _groupList.\r
+     */\r
+    private java.util.Vector _groupList;\r
+\r
+\r
+      //----------------/\r
+     //- Constructors -/\r
+    //----------------/\r
+\r
+    public FeatureSettings() {\r
+        super();\r
+        this._settingList = new java.util.Vector();\r
+        this._groupList = new java.util.Vector();\r
+    }\r
+\r
+\r
+      //-----------/\r
+     //- Methods -/\r
+    //-----------/\r
+\r
+    /**\r
+     * \r
+     * \r
+     * @param vGroup\r
+     * @throws java.lang.IndexOutOfBoundsException if the index\r
+     * given is outside the bounds of the collection\r
+     */\r
+    public void addGroup(\r
+            final jalview.schemabinding.version2.Group vGroup)\r
+    throws java.lang.IndexOutOfBoundsException {\r
+        this._groupList.addElement(vGroup);\r
+    }\r
+\r
+    /**\r
+     * \r
+     * \r
+     * @param index\r
+     * @param vGroup\r
+     * @throws java.lang.IndexOutOfBoundsException if the index\r
+     * given is outside the bounds of the collection\r
+     */\r
+    public void addGroup(\r
+            final int index,\r
+            final jalview.schemabinding.version2.Group vGroup)\r
+    throws java.lang.IndexOutOfBoundsException {\r
+        this._groupList.add(index, vGroup);\r
     }\r
 \r
-    return (jalview.schemabinding.version2.Setting) _settingList.elementAt(\r
-        index);\r
-  } //-- jalview.schemabinding.version2.Setting getSetting(int)\r
-\r
-  /**\r
-   * Method getSetting\r
-   *\r
-   *\r
-   *\r
-   * @return Setting\r
-   */\r
-  public jalview.schemabinding.version2.Setting[] getSetting()\r
-  {\r
-    int size = _settingList.size();\r
-    jalview.schemabinding.version2.Setting[] mArray = new jalview.schemabinding.\r
-        version2.Setting[size];\r
-    for (int index = 0; index < size; index++)\r
-    {\r
-      mArray[index] = (jalview.schemabinding.version2.Setting) _settingList.\r
-          elementAt(index);\r
+    /**\r
+     * \r
+     * \r
+     * @param vSetting\r
+     * @throws java.lang.IndexOutOfBoundsException if the index\r
+     * given is outside the bounds of the collection\r
+     */\r
+    public void addSetting(\r
+            final jalview.schemabinding.version2.Setting vSetting)\r
+    throws java.lang.IndexOutOfBoundsException {\r
+        this._settingList.addElement(vSetting);\r
     }\r
-    return mArray;\r
-  } //-- jalview.schemabinding.version2.Setting[] getSetting()\r
-\r
-  /**\r
-   * Method getSettingCount\r
-   *\r
-   *\r
-   *\r
-   * @return int\r
-   */\r
-  public int getSettingCount()\r
-  {\r
-    return _settingList.size();\r
-  } //-- int getSettingCount()\r
-\r
-  /**\r
-   * Method isValid\r
-   *\r
-   *\r
-   *\r
-   * @return boolean\r
-   */\r
-  public boolean isValid()\r
-  {\r
-    try\r
-    {\r
-      validate();\r
+\r
+    /**\r
+     * \r
+     * \r
+     * @param index\r
+     * @param vSetting\r
+     * @throws java.lang.IndexOutOfBoundsException if the index\r
+     * given is outside the bounds of the collection\r
+     */\r
+    public void addSetting(\r
+            final int index,\r
+            final jalview.schemabinding.version2.Setting vSetting)\r
+    throws java.lang.IndexOutOfBoundsException {\r
+        this._settingList.add(index, vSetting);\r
+    }\r
+\r
+    /**\r
+     * Method enumerateGroup.\r
+     * \r
+     * @return an Enumeration over all\r
+     * jalview.schemabinding.version2.Group elements\r
+     */\r
+    public java.util.Enumeration enumerateGroup(\r
+    ) {\r
+        return this._groupList.elements();\r
+    }\r
+\r
+    /**\r
+     * Method enumerateSetting.\r
+     * \r
+     * @return an Enumeration over all\r
+     * jalview.schemabinding.version2.Setting elements\r
+     */\r
+    public java.util.Enumeration enumerateSetting(\r
+    ) {\r
+        return this._settingList.elements();\r
+    }\r
+\r
+    /**\r
+     * Method getGroup.\r
+     * \r
+     * @param index\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.Group at the given index\r
+     */\r
+    public jalview.schemabinding.version2.Group getGroup(\r
+            final int index)\r
+    throws java.lang.IndexOutOfBoundsException {\r
+        // check bounds for index\r
+        if (index < 0 || index >= this._groupList.size()) {\r
+            throw new IndexOutOfBoundsException("getGroup: Index value '" + index + "' not in range [0.." + (this._groupList.size() - 1) + "]");\r
+        }\r
+        \r
+        return (jalview.schemabinding.version2.Group) _groupList.get(index);\r
     }\r
-    catch (org.exolab.castor.xml.ValidationException vex)\r
-    {\r
-      return false;\r
+\r
+    /**\r
+     * Method getGroup.Returns the contents of the collection in an\r
+     * Array.  <p>Note:  Just in case the collection contents are\r
+     * changing in another thread, we pass a 0-length Array of the\r
+     * 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 this collection as an Array\r
+     */\r
+    public jalview.schemabinding.version2.Group[] getGroup(\r
+    ) {\r
+        jalview.schemabinding.version2.Group[] array = new jalview.schemabinding.version2.Group[0];\r
+        return (jalview.schemabinding.version2.Group[]) this._groupList.toArray(array);\r
     }\r
-    return true;\r
-  } //-- boolean isValid()\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,\r
-      org.exolab.castor.xml.ValidationException\r
-  {\r
-\r
-    Marshaller.marshal(this, out);\r
-  } //-- void marshal(java.io.Writer)\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,\r
-      org.exolab.castor.xml.ValidationException\r
-  {\r
-\r
-    Marshaller.marshal(this, handler);\r
-  } //-- void marshal(org.xml.sax.ContentHandler)\r
-\r
-  /**\r
-   * Method removeAllSetting\r
-   *\r
-   */\r
-  public void removeAllSetting()\r
-  {\r
-    _settingList.removeAllElements();\r
-  } //-- void removeAllSetting()\r
-\r
-  /**\r
-   * Method removeSetting\r
-   *\r
-   *\r
-   *\r
-   * @param index\r
-   * @return Setting\r
-   */\r
-  public jalview.schemabinding.version2.Setting removeSetting(int index)\r
-  {\r
-    java.lang.Object obj = _settingList.elementAt(index);\r
-    _settingList.removeElementAt(index);\r
-    return (jalview.schemabinding.version2.Setting) obj;\r
-  } //-- jalview.schemabinding.version2.Setting removeSetting(int)\r
-\r
-  /**\r
-   * Method setSetting\r
-   *\r
-   *\r
-   *\r
-   * @param index\r
-   * @param vSetting\r
-   */\r
-  public void setSetting(int index,\r
-                         jalview.schemabinding.version2.Setting vSetting)\r
-      throws java.lang.IndexOutOfBoundsException\r
-  {\r
-    //-- check bounds for index\r
-    if ( (index < 0) || (index > _settingList.size()))\r
-    {\r
-      throw new IndexOutOfBoundsException();\r
+\r
+    /**\r
+     * Method getGroupCount.\r
+     * \r
+     * @return the size of this collection\r
+     */\r
+    public int getGroupCount(\r
+    ) {\r
+        return this._groupList.size();\r
+    }\r
+\r
+    /**\r
+     * Method getSetting.\r
+     * \r
+     * @param index\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.Setting at the given index\r
+     */\r
+    public jalview.schemabinding.version2.Setting getSetting(\r
+            final int index)\r
+    throws java.lang.IndexOutOfBoundsException {\r
+        // check bounds for index\r
+        if (index < 0 || index >= this._settingList.size()) {\r
+            throw new IndexOutOfBoundsException("getSetting: Index value '" + index + "' not in range [0.." + (this._settingList.size() - 1) + "]");\r
+        }\r
+        \r
+        return (jalview.schemabinding.version2.Setting) _settingList.get(index);\r
+    }\r
+\r
+    /**\r
+     * Method getSetting.Returns the contents of the collection in\r
+     * 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 this collection as an Array\r
+     */\r
+    public jalview.schemabinding.version2.Setting[] getSetting(\r
+    ) {\r
+        jalview.schemabinding.version2.Setting[] array = new jalview.schemabinding.version2.Setting[0];\r
+        return (jalview.schemabinding.version2.Setting[]) this._settingList.toArray(array);\r
+    }\r
+\r
+    /**\r
+     * Method getSettingCount.\r
+     * \r
+     * @return the size of this collection\r
+     */\r
+    public int getSettingCount(\r
+    ) {\r
+        return this._settingList.size();\r
     }\r
-    _settingList.setElementAt(vSetting, index);\r
-  } //-- void setSetting(int, jalview.schemabinding.version2.Setting)\r
-\r
-  /**\r
-   * Method setSetting\r
-   *\r
-   *\r
-   *\r
-   * @param settingArray\r
-   */\r
-  public void setSetting(jalview.schemabinding.version2.Setting[] settingArray)\r
-  {\r
-    //-- copy array\r
-    _settingList.removeAllElements();\r
-    for (int i = 0; i < settingArray.length; i++)\r
-    {\r
-      _settingList.addElement(settingArray[i]);\r
+\r
+    /**\r
+     * Method isValid.\r
+     * \r
+     * @return true if this object is valid according to the schema\r
+     */\r
+    public boolean isValid(\r
+    ) {\r
+        try {\r
+            validate();\r
+        } catch (org.exolab.castor.xml.ValidationException vex) {\r
+            return false;\r
+        }\r
+        return true;\r
+    }\r
+\r
+    /**\r
+     * \r
+     * \r
+     * @param out\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
+    }\r
+\r
+    /**\r
+     * \r
+     * \r
+     * @param handler\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
+    }\r
+\r
+    /**\r
+     */\r
+    public void removeAllGroup(\r
+    ) {\r
+        this._groupList.clear();\r
+    }\r
+\r
+    /**\r
+     */\r
+    public void removeAllSetting(\r
+    ) {\r
+        this._settingList.clear();\r
+    }\r
+\r
+    /**\r
+     * Method removeGroup.\r
+     * \r
+     * @param vGroup\r
+     * @return true if the object was removed from the collection.\r
+     */\r
+    public boolean removeGroup(\r
+            final jalview.schemabinding.version2.Group vGroup) {\r
+        boolean removed = _groupList.remove(vGroup);\r
+        return removed;\r
+    }\r
+\r
+    /**\r
+     * Method removeGroupAt.\r
+     * \r
+     * @param index\r
+     * @return the element removed from the collection\r
+     */\r
+    public jalview.schemabinding.version2.Group removeGroupAt(\r
+            final int index) {\r
+        java.lang.Object obj = this._groupList.remove(index);\r
+        return (jalview.schemabinding.version2.Group) obj;\r
+    }\r
+\r
+    /**\r
+     * Method removeSetting.\r
+     * \r
+     * @param vSetting\r
+     * @return true if the object was removed from the collection.\r
+     */\r
+    public boolean removeSetting(\r
+            final jalview.schemabinding.version2.Setting vSetting) {\r
+        boolean removed = _settingList.remove(vSetting);\r
+        return removed;\r
+    }\r
+\r
+    /**\r
+     * Method removeSettingAt.\r
+     * \r
+     * @param index\r
+     * @return the element removed from the collection\r
+     */\r
+    public jalview.schemabinding.version2.Setting removeSettingAt(\r
+            final int index) {\r
+        java.lang.Object obj = this._settingList.remove(index);\r
+        return (jalview.schemabinding.version2.Setting) obj;\r
+    }\r
+\r
+    /**\r
+     * \r
+     * \r
+     * @param index\r
+     * @param vGroup\r
+     * @throws java.lang.IndexOutOfBoundsException if the index\r
+     * given is outside the bounds of the collection\r
+     */\r
+    public void setGroup(\r
+            final int index,\r
+            final jalview.schemabinding.version2.Group vGroup)\r
+    throws java.lang.IndexOutOfBoundsException {\r
+        // check bounds for index\r
+        if (index < 0 || index >= this._groupList.size()) {\r
+            throw new IndexOutOfBoundsException("setGroup: Index value '" + index + "' not in range [0.." + (this._groupList.size() - 1) + "]");\r
+        }\r
+        \r
+        this._groupList.set(index, vGroup);\r
+    }\r
+\r
+    /**\r
+     * \r
+     * \r
+     * @param vGroupArray\r
+     */\r
+    public void setGroup(\r
+            final jalview.schemabinding.version2.Group[] vGroupArray) {\r
+        //-- copy array\r
+        _groupList.clear();\r
+        \r
+        for (int i = 0; i < vGroupArray.length; i++) {\r
+                this._groupList.add(vGroupArray[i]);\r
+        }\r
+    }\r
+\r
+    /**\r
+     * \r
+     * \r
+     * @param index\r
+     * @param vSetting\r
+     * @throws java.lang.IndexOutOfBoundsException if the index\r
+     * given is outside the bounds of the collection\r
+     */\r
+    public void setSetting(\r
+            final int index,\r
+            final jalview.schemabinding.version2.Setting vSetting)\r
+    throws java.lang.IndexOutOfBoundsException {\r
+        // check bounds for index\r
+        if (index < 0 || index >= this._settingList.size()) {\r
+            throw new IndexOutOfBoundsException("setSetting: Index value '" + index + "' not in range [0.." + (this._settingList.size() - 1) + "]");\r
+        }\r
+        \r
+        this._settingList.set(index, vSetting);\r
+    }\r
+\r
+    /**\r
+     * \r
+     * \r
+     * @param vSettingArray\r
+     */\r
+    public void setSetting(\r
+            final jalview.schemabinding.version2.Setting[] vSettingArray) {\r
+        //-- copy array\r
+        _settingList.clear();\r
+        \r
+        for (int i = 0; i < vSettingArray.length; i++) {\r
+                this._settingList.add(vSettingArray[i]);\r
+        }\r
+    }\r
+\r
+    /**\r
+     * Method unmarshal.\r
+     * \r
+     * @param reader\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\r
+     * jalview.schemabinding.version2.FeatureSettings\r
+     */\r
+    public static jalview.schemabinding.version2.FeatureSettings unmarshal(\r
+            final java.io.Reader reader)\r
+    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
+        return (jalview.schemabinding.version2.FeatureSettings) Unmarshaller.unmarshal(jalview.schemabinding.version2.FeatureSettings.class, reader);\r
+    }\r
+\r
+    /**\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
+    )\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
     }\r
-  } //-- void setSetting(jalview.schemabinding.version2.Setting)\r
-\r
-  /**\r
-   * Method unmarshal\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,\r
-      org.exolab.castor.xml.ValidationException\r
-  {\r
-    return (jalview.schemabinding.version2.FeatureSettings) Unmarshaller.\r
-        unmarshal(jalview.schemabinding.version2.FeatureSettings.class, reader);\r
-  } //-- java.lang.Object unmarshal(java.io.Reader)\r
-\r
-  /**\r
-   * Method validate\r
-   *\r
-   */\r
-  public void validate()\r
-      throws org.exolab.castor.xml.ValidationException\r
-  {\r
-    org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.\r
-        Validator();\r
-    validator.validate(this);\r
-  } //-- void validate()\r
 \r
 }\r