X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fschemabinding%2Fversion2%2FFeatureSettings.java;h=9bacca3d44eff84c0691a31f415f0d1bc7260992;hb=153dd62dc91da13ae732600e6ea55ddbe15eab39;hp=c20a83cf7f8f8b818b0bec34a998c9e0017aa1f2;hpb=65df62f4b048a1615d32ea2c3576082ad2b63af8;p=jalview.git
diff --git a/src/jalview/schemabinding/version2/FeatureSettings.java b/src/jalview/schemabinding/version2/FeatureSettings.java
index c20a83c..9bacca3 100755
--- a/src/jalview/schemabinding/version2/FeatureSettings.java
+++ b/src/jalview/schemabinding/version2/FeatureSettings.java
@@ -1,274 +1,472 @@
/*
- * This class was automatically generated with
- * Castor 0.9.6, using an XML
- * Schema.
- * $Id$
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
+ * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ *
+ * 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
+ * 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 + * know 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()) { - try { - validate(); - } - catch (org.exolab.castor.xml.ValidationException vex) { - return false; - } - return true; - } //-- boolean isValid() - - /** - * Method marshal - * - * - * - * @param out - */ - public void marshal(java.io.Writer out) - throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException + 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. + *
+ * 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 + * know 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 { - - Marshaller.marshal(this, out); - } //-- void marshal(java.io.Writer) - - /** - * Method marshal - * - * - * - * @param handler - */ - public void marshal(org.xml.sax.ContentHandler handler) - throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException + validate(); + } catch (org.exolab.castor.xml.ValidationException vex) { - - Marshaller.marshal(this, handler); - } //-- void marshal(org.xml.sax.ContentHandler) + return false; + } + return true; + } - /** - * Method removeAllSetting - * - */ - public void removeAllSetting() - { - _settingList.removeAllElements(); - } //-- void removeAllSetting() - - /** - * Method removeSetting - * - * - * - * @param index - * @return Setting + /** + * + * + * @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 jalview.schemabinding.version2.Setting removeSetting(int index) - { - java.lang.Object obj = _settingList.elementAt(index); - _settingList.removeElementAt(index); - return (jalview.schemabinding.version2.Setting) obj; - } //-- jalview.schemabinding.version2.Setting removeSetting(int) - - /** - * Method setSetting - * - * - * - * @param index - * @param vSetting + public void removeAllGroup() + { + this._groupList.clear(); + } + + /** */ - public void setSetting(int index, jalview.schemabinding.version2.Setting vSetting) - throws java.lang.IndexOutOfBoundsException + 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()) { - //-- check bounds for index - if ((index < 0) || (index > _settingList.size())) { - throw new IndexOutOfBoundsException(); - } - _settingList.setElementAt(vSetting, index); - } //-- void setSetting(int, jalview.schemabinding.version2.Setting) - - /** - * Method setSetting - * - * - * - * @param settingArray - */ - public void setSetting(jalview.schemabinding.version2.Setting[] settingArray) + 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++) { - //-- copy array - _settingList.removeAllElements(); - for (int i = 0; i < settingArray.length; i++) { - _settingList.addElement(settingArray[i]); - } - } //-- void setSetting(jalview.schemabinding.version2.Setting) - - /** - * Method unmarshal - * - * - * - * @param reader - * @return Object - */ - public static java.lang.Object unmarshal(java.io.Reader reader) - throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException + 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()) { - return (jalview.schemabinding.version2.FeatureSettings) Unmarshaller.unmarshal(jalview.schemabinding.version2.FeatureSettings.class, reader); - } //-- java.lang.Object unmarshal(java.io.Reader) + throw new IndexOutOfBoundsException("setSetting: Index value '" + + index + "' not in range [0.." + + (this._settingList.size() - 1) + "]"); + } - /** - * Method validate - * - */ - public void validate() - throws org.exolab.castor.xml.ValidationException + 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++) { - org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator(); - validator.validate(this); - } //-- void validate() + 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); + } }