X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;ds=inline;f=src%2Fjalview%2Fschemabinding%2Fversion2%2FFeatureSettings.java;h=19c567c1809ef8cded4b1e6692755c0308d86c41;hb=09e3cf7d0e936a9b69fc8f6c7315195694c5127e;hp=be6c20a6fd21a2d3bc8a7c52ee86069aea00bfc6;hpb=ab43013b7e357b84b4abade0dba949668dfb2a0e;p=jalview.git
diff --git a/src/jalview/schemabinding/version2/FeatureSettings.java b/src/jalview/schemabinding/version2/FeatureSettings.java
index be6c20a..19c567c 100644
--- a/src/jalview/schemabinding/version2/FeatureSettings.java
+++ b/src/jalview/schemabinding/version2/FeatureSettings.java
@@ -1,30 +1,15 @@
/*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2b1)
- * 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
- * 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(MessageManager.formatMessage("exception.index_value_not_in_range", new String[]{ - "getSetting", - Integer.valueOf(index).toString(), - Integer.valueOf((this._settingList.size() - 1)).toString() - })); + + //-----------/ + //- 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); } - 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; + /** + * + * + * @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); } - 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); - } - - /** + + /** + * + * + * @param vSetting + * @throws java.lang.IndexOutOfBoundsException if the index + * given is outside the bounds of the collection */ - public void removeAllGroup() - { - this._groupList.clear(); - } + 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 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(MessageManager.formatMessage("exception.index_value_not_in_range", new String[]{ - "setGroup", - Integer.valueOf(index).toString(), - Integer.valueOf((this._groupList.size() - 1)).toString() - })); + public void addSetting( + final int index, + final jalview.schemabinding.version2.Setting vSetting) + throws java.lang.IndexOutOfBoundsException { + this._settingList.add(index, vSetting); } - 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]); + /** + * Method enumerateGroup. + * + * @return an Enumeration over all + * jalview.schemabinding.version2.Group elements + */ + public java.util.Enumeration enumerateGroup( + ) { + return this._groupList.elements(); } - } - - /** - * - * - * @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(MessageManager.formatMessage("exception.index_value_not_in_range", new String[]{ - "setSetting", - Integer.valueOf(index).toString(), - Integer.valueOf((this._settingList.size() - 1)).toString() - })); + + /** + * 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(); } - 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 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); } - } - - /** - * 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); - } }