JAL-1432 updated copyright notices
[jalview.git] / src / jalview / schemabinding / version2 / FeatureSettings.java
old mode 100755 (executable)
new mode 100644 (file)
index 2dad54a..ed60cfa
-/*\r
- * This class was automatically generated with\r
- * <a href="http://www.castor.org">Castor 0.9.6</a>, using an XML\r
- * Schema.\r
- * $Id$\r
- */\r
-\r
-package jalview.schemabinding.version2;\r
-\r
-//---------------------------------/\r
-//- Imported classes and packages -/\r
-//---------------------------------/\r
-\r
-import java.util.*;\r
-\r
-import org.exolab.castor.xml.*;\r
-\r
-/**\r
- * Class FeatureSettings.\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
-    }\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
-    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
-    catch (org.exolab.castor.xml.ValidationException vex)\r
-    {\r
-      return false;\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
-    _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
-  } //-- 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
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
+ * Copyright (C) 2014 The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * 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 Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+package jalview.schemabinding.version2;
+
+//---------------------------------/
+//- Imported classes and packages -/
+//---------------------------------/
+
+import org.exolab.castor.xml.Marshaller;
+import org.exolab.castor.xml.Unmarshaller;
+
+/**
+ * Class FeatureSettings.
+ * 
+ * @version $Revision$ $Date$
+ */
+public class FeatureSettings implements java.io.Serializable
+{
+
+  // --------------------------/
+  // - Class/Member Variables -/
+  // --------------------------/
+
+  /**
+   * Field _settingList.
+   */
+  private java.util.Vector _settingList;
+
+  /**
+   * Field _groupList.
+   */
+  private java.util.Vector _groupList;
+
+  // ----------------/
+  // - Constructors -/
+  // ----------------/
+
+  public FeatureSettings()
+  {
+    super();
+    this._settingList = new java.util.Vector();
+    this._groupList = new java.util.Vector();
+  }
+
+  // -----------/
+  // - Methods -/
+  // -----------/
+
+  /**
+   * 
+   * 
+   * @param vGroup
+   * @throws java.lang.IndexOutOfBoundsException
+   *           if the index given is outside the bounds of the collection
+   */
+  public void addGroup(final jalview.schemabinding.version2.Group vGroup)
+          throws java.lang.IndexOutOfBoundsException
+  {
+    this._groupList.addElement(vGroup);
+  }
+
+  /**
+   * 
+   * 
+   * @param index
+   * @param vGroup
+   * @throws java.lang.IndexOutOfBoundsException
+   *           if the index given is outside the bounds of the collection
+   */
+  public void addGroup(final int index,
+          final jalview.schemabinding.version2.Group vGroup)
+          throws java.lang.IndexOutOfBoundsException
+  {
+    this._groupList.add(index, vGroup);
+  }
+
+  /**
+   * 
+   * 
+   * @param vSetting
+   * @throws java.lang.IndexOutOfBoundsException
+   *           if the index given is outside the bounds of the collection
+   */
+  public void addSetting(
+          final jalview.schemabinding.version2.Setting vSetting)
+          throws java.lang.IndexOutOfBoundsException
+  {
+    this._settingList.addElement(vSetting);
+  }
+
+  /**
+   * 
+   * 
+   * @param index
+   * @param vSetting
+   * @throws java.lang.IndexOutOfBoundsException
+   *           if the index given is outside the bounds of the collection
+   */
+  public void addSetting(final int index,
+          final jalview.schemabinding.version2.Setting vSetting)
+          throws java.lang.IndexOutOfBoundsException
+  {
+    this._settingList.add(index, vSetting);
+  }
+
+  /**
+   * Method enumerateGroup.
+   * 
+   * @return an Enumeration over all jalview.schemabinding.version2.Group
+   *         elements
+   */
+  public java.util.Enumeration enumerateGroup()
+  {
+    return this._groupList.elements();
+  }
+
+  /**
+   * Method enumerateSetting.
+   * 
+   * @return an Enumeration over all jalview.schemabinding.version2.Setting
+   *         elements
+   */
+  public java.util.Enumeration enumerateSetting()
+  {
+    return this._settingList.elements();
+  }
+
+  /**
+   * Method getGroup.
+   * 
+   * @param index
+   * @throws java.lang.IndexOutOfBoundsException
+   *           if the index given is outside the bounds of the collection
+   * @return the value of the jalview.schemabinding.version2.Group at the given
+   *         index
+   */
+  public jalview.schemabinding.version2.Group getGroup(final int index)
+          throws java.lang.IndexOutOfBoundsException
+  {
+    // check bounds for index
+    if (index < 0 || index >= this._groupList.size())
+    {
+      throw new IndexOutOfBoundsException("getGroup: Index value '" + index
+              + "' not in range [0.." + (this._groupList.size() - 1) + "]");
+    }
+
+    return (jalview.schemabinding.version2.Group) _groupList.get(index);
+  }
+
+  /**
+   * Method getGroup.Returns the contents of the collection in an Array.
+   * <p>
+   * Note: Just in case the collection contents are changing in another thread,
+   * we pass a 0-length Array of the correct type into the API call. This way we
+   * <i>know</i> that the Array returned is of exactly the correct length.
+   * 
+   * @return this collection as an Array
+   */
+  public jalview.schemabinding.version2.Group[] getGroup()
+  {
+    jalview.schemabinding.version2.Group[] array = new jalview.schemabinding.version2.Group[0];
+    return (jalview.schemabinding.version2.Group[]) this._groupList
+            .toArray(array);
+  }
+
+  /**
+   * Method getGroupCount.
+   * 
+   * @return the size of this collection
+   */
+  public int getGroupCount()
+  {
+    return this._groupList.size();
+  }
+
+  /**
+   * Method getSetting.
+   * 
+   * @param index
+   * @throws java.lang.IndexOutOfBoundsException
+   *           if the index given is outside the bounds of the collection
+   * @return the value of the jalview.schemabinding.version2.Setting at the
+   *         given index
+   */
+  public jalview.schemabinding.version2.Setting getSetting(final int index)
+          throws java.lang.IndexOutOfBoundsException
+  {
+    // check bounds for index
+    if (index < 0 || index >= this._settingList.size())
+    {
+      throw new IndexOutOfBoundsException("getSetting: Index value '"
+              + index + "' not in range [0.."
+              + (this._settingList.size() - 1) + "]");
+    }
+
+    return (jalview.schemabinding.version2.Setting) _settingList.get(index);
+  }
+
+  /**
+   * Method getSetting.Returns the contents of the collection in an Array.
+   * <p>
+   * Note: Just in case the collection contents are changing in another thread,
+   * we pass a 0-length Array of the correct type into the API call. This way we
+   * <i>know</i> that the Array returned is of exactly the correct length.
+   * 
+   * @return this collection as an Array
+   */
+  public jalview.schemabinding.version2.Setting[] getSetting()
+  {
+    jalview.schemabinding.version2.Setting[] array = new jalview.schemabinding.version2.Setting[0];
+    return (jalview.schemabinding.version2.Setting[]) this._settingList
+            .toArray(array);
+  }
+
+  /**
+   * Method getSettingCount.
+   * 
+   * @return the size of this collection
+   */
+  public int getSettingCount()
+  {
+    return this._settingList.size();
+  }
+
+  /**
+   * Method isValid.
+   * 
+   * @return true if this object is valid according to the schema
+   */
+  public boolean isValid()
+  {
+    try
+    {
+      validate();
+    } catch (org.exolab.castor.xml.ValidationException vex)
+    {
+      return false;
+    }
+    return true;
+  }
+
+  /**
+   * 
+   * 
+   * @param out
+   * @throws org.exolab.castor.xml.MarshalException
+   *           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
+   */
+  public void marshal(final java.io.Writer out)
+          throws org.exolab.castor.xml.MarshalException,
+          org.exolab.castor.xml.ValidationException
+  {
+    Marshaller.marshal(this, out);
+  }
+
+  /**
+   * 
+   * 
+   * @param handler
+   * @throws java.io.IOException
+   *           if an IOException occurs during marshaling
+   * @throws org.exolab.castor.xml.ValidationException
+   *           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
+   */
+  public void marshal(final org.xml.sax.ContentHandler handler)
+          throws java.io.IOException,
+          org.exolab.castor.xml.MarshalException,
+          org.exolab.castor.xml.ValidationException
+  {
+    Marshaller.marshal(this, handler);
+  }
+
+  /**
+     */
+  public void removeAllGroup()
+  {
+    this._groupList.clear();
+  }
+
+  /**
+     */
+  public void removeAllSetting()
+  {
+    this._settingList.clear();
+  }
+
+  /**
+   * Method removeGroup.
+   * 
+   * @param vGroup
+   * @return true if the object was removed from the collection.
+   */
+  public boolean removeGroup(
+          final jalview.schemabinding.version2.Group vGroup)
+  {
+    boolean removed = _groupList.remove(vGroup);
+    return removed;
+  }
+
+  /**
+   * Method removeGroupAt.
+   * 
+   * @param index
+   * @return the element removed from the collection
+   */
+  public jalview.schemabinding.version2.Group removeGroupAt(final int index)
+  {
+    java.lang.Object obj = this._groupList.remove(index);
+    return (jalview.schemabinding.version2.Group) obj;
+  }
+
+  /**
+   * Method removeSetting.
+   * 
+   * @param vSetting
+   * @return true if the object was removed from the collection.
+   */
+  public boolean removeSetting(
+          final jalview.schemabinding.version2.Setting vSetting)
+  {
+    boolean removed = _settingList.remove(vSetting);
+    return removed;
+  }
+
+  /**
+   * Method removeSettingAt.
+   * 
+   * @param index
+   * @return the element removed from the collection
+   */
+  public jalview.schemabinding.version2.Setting removeSettingAt(
+          final int index)
+  {
+    java.lang.Object obj = this._settingList.remove(index);
+    return (jalview.schemabinding.version2.Setting) obj;
+  }
+
+  /**
+   * 
+   * 
+   * @param index
+   * @param vGroup
+   * @throws java.lang.IndexOutOfBoundsException
+   *           if the index given is outside the bounds of the collection
+   */
+  public void setGroup(final int index,
+          final jalview.schemabinding.version2.Group vGroup)
+          throws java.lang.IndexOutOfBoundsException
+  {
+    // check bounds for index
+    if (index < 0 || index >= this._groupList.size())
+    {
+      throw new IndexOutOfBoundsException("setGroup: Index value '" + index
+              + "' not in range [0.." + (this._groupList.size() - 1) + "]");
+    }
+
+    this._groupList.set(index, vGroup);
+  }
+
+  /**
+   * 
+   * 
+   * @param vGroupArray
+   */
+  public void setGroup(
+          final jalview.schemabinding.version2.Group[] vGroupArray)
+  {
+    // -- copy array
+    _groupList.clear();
+
+    for (int i = 0; i < vGroupArray.length; i++)
+    {
+      this._groupList.add(vGroupArray[i]);
+    }
+  }
+
+  /**
+   * 
+   * 
+   * @param index
+   * @param vSetting
+   * @throws java.lang.IndexOutOfBoundsException
+   *           if the index given is outside the bounds of the collection
+   */
+  public void setSetting(final int index,
+          final jalview.schemabinding.version2.Setting vSetting)
+          throws java.lang.IndexOutOfBoundsException
+  {
+    // check bounds for index
+    if (index < 0 || index >= this._settingList.size())
+    {
+      throw new IndexOutOfBoundsException("setSetting: Index value '"
+              + index + "' not in range [0.."
+              + (this._settingList.size() - 1) + "]");
+    }
+
+    this._settingList.set(index, vSetting);
+  }
+
+  /**
+   * 
+   * 
+   * @param vSettingArray
+   */
+  public void setSetting(
+          final jalview.schemabinding.version2.Setting[] vSettingArray)
+  {
+    // -- copy array
+    _settingList.clear();
+
+    for (int i = 0; i < vSettingArray.length; i++)
+    {
+      this._settingList.add(vSettingArray[i]);
+    }
+  }
+
+  /**
+   * Method unmarshal.
+   * 
+   * @param reader
+   * @throws org.exolab.castor.xml.MarshalException
+   *           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
+   * @return the unmarshaled jalview.schemabinding.version2.FeatureSettings
+   */
+  public static jalview.schemabinding.version2.FeatureSettings unmarshal(
+          final java.io.Reader reader)
+          throws org.exolab.castor.xml.MarshalException,
+          org.exolab.castor.xml.ValidationException
+  {
+    return (jalview.schemabinding.version2.FeatureSettings) Unmarshaller
+            .unmarshal(
+                    jalview.schemabinding.version2.FeatureSettings.class,
+                    reader);
+  }
+
+  /**
+   * 
+   * 
+   * @throws org.exolab.castor.xml.ValidationException
+   *           if this object is an invalid instance according to the schema
+   */
+  public void validate() throws org.exolab.castor.xml.ValidationException
+  {
+    org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
+    validator.validate(this);
+  }
+
+}