X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fschemabinding%2Fversion2%2FFeatureSettings.java;h=5ce4054d25fa6a9dc942cb949b9972dde8d56236;hb=09ee1649c4427f534331aa2017a890529f0932f5;hp=6f641361e2912c2ce0df2046513bf07f1e8d8d4e;hpb=45964a5011035526f997fb39bfc58dec53ffbcec;p=jalview.git

diff --git a/src/jalview/schemabinding/version2/FeatureSettings.java b/src/jalview/schemabinding/version2/FeatureSettings.java
index 6f64136..5ce4054 100755
--- a/src/jalview/schemabinding/version2/FeatureSettings.java
+++ b/src/jalview/schemabinding/version2/FeatureSettings.java
@@ -1,6 +1,6 @@
 /*
  * This class was automatically generated with 
- * <a href="http://www.castor.org">Castor 0.9.6</a>, using an XML
+ * <a href="http://www.castor.org">Castor 1.1</a>, using an XML
  * Schema.
  * $Id$
  */
@@ -11,17 +11,8 @@ package jalview.schemabinding.version2;
  //- Imported classes and packages -/
 //---------------------------------/
 
-import java.io.IOException;
-import java.io.Reader;
-import java.io.Serializable;
-import java.io.Writer;
-import java.util.Enumeration;
-import java.util.Vector;
-import org.exolab.castor.xml.MarshalException;
 import org.exolab.castor.xml.Marshaller;
 import org.exolab.castor.xml.Unmarshaller;
-import org.exolab.castor.xml.ValidationException;
-import org.xml.sax.ContentHandler;
 
 /**
  * Class FeatureSettings.
@@ -36,12 +27,12 @@ public class FeatureSettings implements java.io.Serializable {
     //--------------------------/
 
     /**
-     * Field _settingList
+     * Field _settingList.
      */
     private java.util.Vector _settingList;
 
     /**
-     * Field _groupList
+     * Field _groupList.
      */
     private java.util.Vector _groupList;
 
@@ -52,9 +43,9 @@ public class FeatureSettings implements java.io.Serializable {
 
     public FeatureSettings() {
         super();
-        _settingList = new Vector();
-        _groupList = new Vector();
-    } //-- jalview.schemabinding.version2.FeatureSettings()
+        this._settingList = new java.util.Vector();
+        this._groupList = new java.util.Vector();
+    }
 
 
       //-----------/
@@ -62,364 +53,380 @@ public class FeatureSettings implements java.io.Serializable {
     //-----------/
 
     /**
-     * Method addGroup
-     * 
      * 
      * 
      * @param vGroup
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
      */
-    public void addGroup(jalview.schemabinding.version2.Group vGroup)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        _groupList.addElement(vGroup);
-    } //-- void addGroup(jalview.schemabinding.version2.Group) 
+    public void addGroup(
+            final jalview.schemabinding.version2.Group vGroup)
+    throws java.lang.IndexOutOfBoundsException {
+        this._groupList.addElement(vGroup);
+    }
 
     /**
-     * Method addGroup
-     * 
      * 
      * 
      * @param index
      * @param vGroup
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
      */
-    public void addGroup(int index, jalview.schemabinding.version2.Group vGroup)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        _groupList.insertElementAt(vGroup, index);
-    } //-- void addGroup(int, jalview.schemabinding.version2.Group) 
+    public void addGroup(
+            final int index,
+            final jalview.schemabinding.version2.Group vGroup)
+    throws java.lang.IndexOutOfBoundsException {
+        this._groupList.add(index, vGroup);
+    }
 
     /**
-     * Method addSetting
-     * 
      * 
      * 
      * @param vSetting
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
      */
-    public void addSetting(jalview.schemabinding.version2.Setting vSetting)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        _settingList.addElement(vSetting);
-    } //-- void addSetting(jalview.schemabinding.version2.Setting) 
+    public void addSetting(
+            final jalview.schemabinding.version2.Setting vSetting)
+    throws java.lang.IndexOutOfBoundsException {
+        this._settingList.addElement(vSetting);
+    }
 
     /**
-     * Method addSetting
-     * 
      * 
      * 
      * @param index
      * @param vSetting
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
      */
-    public void addSetting(int index, jalview.schemabinding.version2.Setting vSetting)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        _settingList.insertElementAt(vSetting, index);
-    } //-- void addSetting(int, jalview.schemabinding.version2.Setting) 
+    public void addSetting(
+            final int index,
+            final jalview.schemabinding.version2.Setting vSetting)
+    throws java.lang.IndexOutOfBoundsException {
+        this._settingList.add(index, vSetting);
+    }
 
     /**
-     * Method enumerateGroup
+     * Method enumerateGroup.
      * 
-     * 
-     * 
-     * @return Enumeration
+     * @return an Enumeration over all
+     * jalview.schemabinding.version2.Group elements
      */
-    public java.util.Enumeration enumerateGroup()
-    {
-        return _groupList.elements();
-    } //-- java.util.Enumeration enumerateGroup() 
+    public java.util.Enumeration enumerateGroup(
+    ) {
+        return this._groupList.elements();
+    }
 
     /**
-     * Method enumerateSetting
-     * 
+     * Method enumerateSetting.
      * 
-     * 
-     * @return Enumeration
+     * @return an Enumeration over all
+     * jalview.schemabinding.version2.Setting elements
      */
-    public java.util.Enumeration enumerateSetting()
-    {
-        return _settingList.elements();
-    } //-- java.util.Enumeration enumerateSetting() 
+    public java.util.Enumeration enumerateSetting(
+    ) {
+        return this._settingList.elements();
+    }
 
     /**
-     * Method getGroup
-     * 
-     * 
+     * Method getGroup.
      * 
      * @param index
-     * @return Group
+     * @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(int index)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        //-- check bounds for index
-        if ((index < 0) || (index > _groupList.size())) {
-            throw new IndexOutOfBoundsException();
+    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.elementAt(index);
-    } //-- jalview.schemabinding.version2.Group getGroup(int) 
+        return (jalview.schemabinding.version2.Group) _groupList.get(index);
+    }
 
     /**
-     * Method getGroup
+     * 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 Group
+     * @return this collection as an Array
      */
-    public jalview.schemabinding.version2.Group[] getGroup()
-    {
-        int size = _groupList.size();
-        jalview.schemabinding.version2.Group[] mArray = new jalview.schemabinding.version2.Group[size];
-        for (int index = 0; index < size; index++) {
-            mArray[index] = (jalview.schemabinding.version2.Group) _groupList.elementAt(index);
-        }
-        return mArray;
-    } //-- jalview.schemabinding.version2.Group[] getGroup() 
+    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
+     * Method getGroupCount.
      * 
-     * 
-     * 
-     * @return int
+     * @return the size of this collection
      */
-    public int getGroupCount()
-    {
-        return _groupList.size();
-    } //-- int getGroupCount() 
+    public int getGroupCount(
+    ) {
+        return this._groupList.size();
+    }
 
     /**
-     * Method getSetting
-     * 
-     * 
+     * Method getSetting.
      * 
      * @param index
-     * @return Setting
+     * @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(int index)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        //-- check bounds for index
-        if ((index < 0) || (index > _settingList.size())) {
-            throw new IndexOutOfBoundsException();
+    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.elementAt(index);
-    } //-- jalview.schemabinding.version2.Setting getSetting(int) 
+        return (jalview.schemabinding.version2.Setting) _settingList.get(index);
+    }
 
     /**
-     * Method getSetting
+     * 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 Setting
+     * @return this collection as an Array
      */
-    public jalview.schemabinding.version2.Setting[] getSetting()
-    {
-        int size = _settingList.size();
-        jalview.schemabinding.version2.Setting[] mArray = new jalview.schemabinding.version2.Setting[size];
-        for (int index = 0; index < size; index++) {
-            mArray[index] = (jalview.schemabinding.version2.Setting) _settingList.elementAt(index);
-        }
-        return mArray;
-    } //-- jalview.schemabinding.version2.Setting[] getSetting() 
+    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
+     * Method getSettingCount.
      * 
-     * 
-     * 
-     * @return int
+     * @return the size of this collection
      */
-    public int getSettingCount()
-    {
-        return _settingList.size();
-    } //-- int getSettingCount() 
+    public int getSettingCount(
+    ) {
+        return this._settingList.size();
+    }
 
     /**
-     * Method isValid
-     * 
+     * Method isValid.
      * 
-     * 
-     * @return boolean
+     * @return true if this object is valid according to the schema
      */
-    public boolean isValid()
-    {
+    public boolean isValid(
+    ) {
         try {
             validate();
-        }
-        catch (org.exolab.castor.xml.ValidationException vex) {
+        } catch (org.exolab.castor.xml.ValidationException vex) {
             return false;
         }
         return true;
-    } //-- boolean isValid() 
+    }
 
     /**
-     * Method marshal
-     * 
      * 
      * 
      * @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(java.io.Writer out)
-        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
-    {
-        
+    public void marshal(
+            final java.io.Writer out)
+    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
         Marshaller.marshal(this, out);
-    } //-- void marshal(java.io.Writer) 
+    }
 
     /**
-     * Method marshal
-     * 
      * 
      * 
      * @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(org.xml.sax.ContentHandler handler)
-        throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
-    {
-        
+    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);
-    } //-- void marshal(org.xml.sax.ContentHandler) 
+    }
 
     /**
-     * Method removeAllGroup
-     * 
      */
-    public void removeAllGroup()
-    {
-        _groupList.removeAllElements();
-    } //-- void removeAllGroup() 
+    public void removeAllGroup(
+    ) {
+        this._groupList.clear();
+    }
 
     /**
-     * Method removeAllSetting
-     * 
      */
-    public void removeAllSetting()
-    {
-        _settingList.removeAllElements();
-    } //-- void removeAllSetting() 
+    public void removeAllSetting(
+    ) {
+        this._settingList.clear();
+    }
 
     /**
-     * Method removeGroup
-     * 
+     * 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 Group
+     * @return the element removed from the collection
      */
-    public jalview.schemabinding.version2.Group removeGroup(int index)
-    {
-        java.lang.Object obj = _groupList.elementAt(index);
-        _groupList.removeElementAt(index);
+    public jalview.schemabinding.version2.Group removeGroupAt(
+            final int index) {
+        java.lang.Object obj = this._groupList.remove(index);
         return (jalview.schemabinding.version2.Group) obj;
-    } //-- jalview.schemabinding.version2.Group removeGroup(int) 
+    }
 
     /**
-     * Method removeSetting
-     * 
+     * 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 Setting
+     * @return the element removed from the collection
      */
-    public jalview.schemabinding.version2.Setting removeSetting(int index)
-    {
-        java.lang.Object obj = _settingList.elementAt(index);
-        _settingList.removeElementAt(index);
+    public jalview.schemabinding.version2.Setting removeSettingAt(
+            final int index) {
+        java.lang.Object obj = this._settingList.remove(index);
         return (jalview.schemabinding.version2.Setting) obj;
-    } //-- jalview.schemabinding.version2.Setting removeSetting(int) 
+    }
 
     /**
-     * Method setGroup
-     * 
      * 
      * 
      * @param index
      * @param vGroup
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
      */
-    public void setGroup(int index, jalview.schemabinding.version2.Group vGroup)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        //-- check bounds for index
-        if ((index < 0) || (index > _groupList.size())) {
-            throw new IndexOutOfBoundsException();
+    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) + "]");
         }
-        _groupList.setElementAt(vGroup, index);
-    } //-- void setGroup(int, jalview.schemabinding.version2.Group) 
+        
+        this._groupList.set(index, vGroup);
+    }
 
     /**
-     * Method setGroup
      * 
      * 
-     * 
-     * @param groupArray
+     * @param vGroupArray
      */
-    public void setGroup(jalview.schemabinding.version2.Group[] groupArray)
-    {
+    public void setGroup(
+            final jalview.schemabinding.version2.Group[] vGroupArray) {
         //-- copy array
-        _groupList.removeAllElements();
-        for (int i = 0; i < groupArray.length; i++) {
-            _groupList.addElement(groupArray[i]);
+        _groupList.clear();
+        
+        for (int i = 0; i < vGroupArray.length; i++) {
+                this._groupList.add(vGroupArray[i]);
         }
-    } //-- void setGroup(jalview.schemabinding.version2.Group) 
+    }
 
     /**
-     * Method setSetting
-     * 
      * 
      * 
      * @param index
      * @param vSetting
+     * @throws java.lang.IndexOutOfBoundsException if the index
+     * given is outside the bounds of the collection
      */
-    public void setSetting(int index, jalview.schemabinding.version2.Setting vSetting)
-        throws java.lang.IndexOutOfBoundsException
-    {
-        //-- check bounds for index
-        if ((index < 0) || (index > _settingList.size())) {
-            throw new IndexOutOfBoundsException();
+    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) + "]");
         }
-        _settingList.setElementAt(vSetting, index);
-    } //-- void setSetting(int, jalview.schemabinding.version2.Setting) 
+        
+        this._settingList.set(index, vSetting);
+    }
 
     /**
-     * Method setSetting
-     * 
      * 
      * 
-     * @param settingArray
+     * @param vSettingArray
      */
-    public void setSetting(jalview.schemabinding.version2.Setting[] settingArray)
-    {
+    public void setSetting(
+            final jalview.schemabinding.version2.Setting[] vSettingArray) {
         //-- copy array
-        _settingList.removeAllElements();
-        for (int i = 0; i < settingArray.length; i++) {
-            _settingList.addElement(settingArray[i]);
+        _settingList.clear();
+        
+        for (int i = 0; i < vSettingArray.length; i++) {
+                this._settingList.add(vSettingArray[i]);
         }
-    } //-- void setSetting(jalview.schemabinding.version2.Setting) 
+    }
 
     /**
-     * Method unmarshal
-     * 
-     * 
+     * Method unmarshal.
      * 
      * @param reader
-     * @return Object
+     * @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 java.lang.Object unmarshal(java.io.Reader reader)
-        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
-    {
+    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);
-    } //-- java.lang.Object unmarshal(java.io.Reader) 
+    }
 
     /**
-     * Method validate
      * 
+     * 
+     * @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
-    {
+    public void validate(
+    )
+    throws org.exolab.castor.xml.ValidationException {
         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
         validator.validate(this);
-    } //-- void validate() 
+    }
 
 }