X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fschemabinding%2Fversion2%2FFeatureSettings.java;h=ed60cfa133ef19ef9c135f2165c4246d5e65e02b;hb=865a855a4ca87eadb3e5ff284ed32ed307d9c34b;hp=c20a83cf7f8f8b818b0bec34a998c9e0017aa1f2;hpb=48df59aa393e03aa7269b2df662ac1b8d58cbb25;p=jalview.git diff --git a/src/jalview/schemabinding/version2/FeatureSettings.java b/src/jalview/schemabinding/version2/FeatureSettings.java old mode 100755 new mode 100644 index c20a83c..ed60cfa --- a/src/jalview/schemabinding/version2/FeatureSettings.java +++ b/src/jalview/schemabinding/version2/FeatureSettings.java @@ -1,274 +1,473 @@ -/* - * This class was automatically generated with - * Castor 0.9.6, using an XML - * Schema. - * $Id$ - */ - -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. - * - * @version $Revision$ $Date$ - */ -public class FeatureSettings implements java.io.Serializable { - - - //--------------------------/ - //- Class/Member Variables -/ - //--------------------------/ - - /** - * Field _settingList - */ - private java.util.Vector _settingList; - - - //----------------/ - //- Constructors -/ - //----------------/ - - public FeatureSettings() { - super(); - _settingList = new Vector(); - } //-- jalview.schemabinding.version2.FeatureSettings() - - - //-----------/ - //- Methods -/ - //-----------/ - - /** - * Method addSetting - * - * - * - * @param vSetting - */ - public void addSetting(jalview.schemabinding.version2.Setting vSetting) - throws java.lang.IndexOutOfBoundsException - { - _settingList.addElement(vSetting); - } //-- void addSetting(jalview.schemabinding.version2.Setting) - - /** - * Method addSetting - * - * - * - * @param index - * @param vSetting - */ - 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) - - /** - * Method enumerateSetting - * - * - * - * @return Enumeration - */ - public java.util.Enumeration enumerateSetting() - { - return _settingList.elements(); - } //-- java.util.Enumeration enumerateSetting() - - /** - * Method getSetting - * - * - * - * @param index - * @return Setting - */ - 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(); - } - - return (jalview.schemabinding.version2.Setting) _settingList.elementAt(index); - } //-- jalview.schemabinding.version2.Setting getSetting(int) - - /** - * Method getSetting - * - * - * - * @return Setting - */ - 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() - - /** - * Method getSettingCount - * - * - * - * @return int - */ - public int getSettingCount() - { - return _settingList.size(); - } //-- int getSettingCount() - - /** - * Method isValid - * - * - * - * @return boolean - */ - public boolean isValid() - { - 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 - { - - 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 - { - - Marshaller.marshal(this, handler); - } //-- void marshal(org.xml.sax.ContentHandler) - - /** - * Method removeAllSetting - * - */ - public void removeAllSetting() - { - _settingList.removeAllElements(); - } //-- void removeAllSetting() - - /** - * Method removeSetting - * - * - * - * @param index - * @return Setting - */ - 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 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(); - } - _settingList.setElementAt(vSetting, index); - } //-- void setSetting(int, jalview.schemabinding.version2.Setting) - - /** - * Method setSetting - * - * - * - * @param settingArray - */ - public void setSetting(jalview.schemabinding.version2.Setting[] settingArray) - { - //-- 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 - { - return (jalview.schemabinding.version2.FeatureSettings) Unmarshaller.unmarshal(jalview.schemabinding.version2.FeatureSettings.class, reader); - } //-- java.lang.Object unmarshal(java.io.Reader) - - /** - * Method validate - * - */ - 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() - -} +/* + * 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 . + * 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. + *

+ * 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()) + { + 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 + { + 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); + } + +}