/*\r
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)\r
- * Copyright (C) 2008 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
- * \r
- * This program is free software; you can redistribute it and/or\r
- * modify it under the terms of the GNU General Public License\r
- * as published by the Free Software Foundation; either version 2\r
- * of the License, or (at your option) any later version.\r
- * \r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
- * GNU General Public License for more details.\r
- * \r
- * You should have received a copy of the GNU General Public License\r
- * along with this program; if not, write to the Free Software\r
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA\r
+ * This class was automatically generated with \r
+ * <a href="http://www.castor.org">Castor 1.1</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
+ //- Imported classes and packages -/\r
+//---------------------------------/\r
\r
import org.exolab.castor.xml.Marshaller;\r
import org.exolab.castor.xml.Unmarshaller;\r
* \r
* @version $Revision$ $Date$\r
*/\r
-public class JalviewUserColours implements java.io.Serializable\r
-{\r
-\r
- // --------------------------/\r
- // - Class/Member Variables -/\r
- // --------------------------/\r
-\r
- /**\r
- * Field _schemeName.\r
- */\r
- private java.lang.String _schemeName;\r
-\r
- /**\r
- * Field _colourList.\r
- */\r
- private java.util.Vector _colourList;\r
-\r
- // ----------------/\r
- // - Constructors -/\r
- // ----------------/\r
-\r
- public JalviewUserColours()\r
- {\r
- super();\r
- this._colourList = new java.util.Vector();\r
- }\r
-\r
- // -----------/\r
- // - Methods -/\r
- // -----------/\r
-\r
- /**\r
- * \r
- * \r
- * @param vColour\r
- * @throws java.lang.IndexOutOfBoundsException\r
- * if the index given is outside the bounds of the collection\r
- */\r
- public void addColour(final Colour vColour)\r
- throws java.lang.IndexOutOfBoundsException\r
- {\r
- this._colourList.addElement(vColour);\r
- }\r
-\r
- /**\r
- * \r
- * \r
- * @param index\r
- * @param vColour\r
- * @throws java.lang.IndexOutOfBoundsException\r
- * if the index given is outside the bounds of the collection\r
- */\r
- public void addColour(final int index, final Colour vColour)\r
- throws java.lang.IndexOutOfBoundsException\r
- {\r
- this._colourList.add(index, vColour);\r
- }\r
-\r
- /**\r
- * Method enumerateColour.\r
- * \r
- * @return an Enumeration over all Colour elements\r
- */\r
- public java.util.Enumeration enumerateColour()\r
- {\r
- return this._colourList.elements();\r
- }\r
-\r
- /**\r
- * Method getColour.\r
- * \r
- * @param index\r
- * @throws java.lang.IndexOutOfBoundsException\r
- * if the index given is outside the bounds of the collection\r
- * @return the value of the Colour at the given index\r
- */\r
- public Colour getColour(final int index)\r
- throws java.lang.IndexOutOfBoundsException\r
- {\r
- // check bounds for index\r
- if (index < 0 || index >= this._colourList.size())\r
- {\r
- throw new IndexOutOfBoundsException("getColour: Index value '"\r
- + index + "' not in range [0.."\r
- + (this._colourList.size() - 1) + "]");\r
+public class JalviewUserColours implements java.io.Serializable {\r
+\r
+\r
+ //--------------------------/\r
+ //- Class/Member Variables -/\r
+ //--------------------------/\r
+\r
+ /**\r
+ * Field _schemeName.\r
+ */\r
+ private java.lang.String _schemeName;\r
+\r
+ /**\r
+ * Field _colourList.\r
+ */\r
+ private java.util.Vector _colourList;\r
+\r
+\r
+ //----------------/\r
+ //- Constructors -/\r
+ //----------------/\r
+\r
+ public JalviewUserColours() {\r
+ super();\r
+ this._colourList = new java.util.Vector();\r
+ }\r
+\r
+\r
+ //-----------/\r
+ //- Methods -/\r
+ //-----------/\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param vColour\r
+ * @throws java.lang.IndexOutOfBoundsException if the index\r
+ * given is outside the bounds of the collection\r
+ */\r
+ public void addColour(\r
+ final Colour vColour)\r
+ throws java.lang.IndexOutOfBoundsException {\r
+ this._colourList.addElement(vColour);\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param index\r
+ * @param vColour\r
+ * @throws java.lang.IndexOutOfBoundsException if the index\r
+ * given is outside the bounds of the collection\r
+ */\r
+ public void addColour(\r
+ final int index,\r
+ final Colour vColour)\r
+ throws java.lang.IndexOutOfBoundsException {\r
+ this._colourList.add(index, vColour);\r
+ }\r
+\r
+ /**\r
+ * Method enumerateColour.\r
+ * \r
+ * @return an Enumeration over all Colour elements\r
+ */\r
+ public java.util.Enumeration enumerateColour(\r
+ ) {\r
+ return this._colourList.elements();\r
+ }\r
+\r
+ /**\r
+ * Method getColour.\r
+ * \r
+ * @param index\r
+ * @throws java.lang.IndexOutOfBoundsException if the index\r
+ * given is outside the bounds of the collection\r
+ * @return the value of the Colour at the given index\r
+ */\r
+ public Colour getColour(\r
+ final int index)\r
+ throws java.lang.IndexOutOfBoundsException {\r
+ // check bounds for index\r
+ if (index < 0 || index >= this._colourList.size()) {\r
+ throw new IndexOutOfBoundsException("getColour: Index value '" + index + "' not in range [0.." + (this._colourList.size() - 1) + "]");\r
+ }\r
+ \r
+ return (Colour) _colourList.get(index);\r
+ }\r
+\r
+ /**\r
+ * Method getColour.Returns the contents of the collection in\r
+ * an Array. <p>Note: Just in case the collection contents\r
+ * are changing in another thread, we pass a 0-length Array of\r
+ * the correct type into the API call. This way we <i>know</i>\r
+ * that the Array returned is of exactly the correct length.\r
+ * \r
+ * @return this collection as an Array\r
+ */\r
+ public Colour[] getColour(\r
+ ) {\r
+ Colour[] array = new Colour[0];\r
+ return (Colour[]) this._colourList.toArray(array);\r
+ }\r
+\r
+ /**\r
+ * Method getColourCount.\r
+ * \r
+ * @return the size of this collection\r
+ */\r
+ public int getColourCount(\r
+ ) {\r
+ return this._colourList.size();\r
+ }\r
+\r
+ /**\r
+ * Returns the value of field 'schemeName'.\r
+ * \r
+ * @return the value of field 'SchemeName'.\r
+ */\r
+ public java.lang.String getSchemeName(\r
+ ) {\r
+ return this._schemeName;\r
+ }\r
+\r
+ /**\r
+ * Method isValid.\r
+ * \r
+ * @return true if this object is valid according to the schema\r
+ */\r
+ public boolean isValid(\r
+ ) {\r
+ try {\r
+ validate();\r
+ } catch (org.exolab.castor.xml.ValidationException vex) {\r
+ return false;\r
+ }\r
+ return true;\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param out\r
+ * @throws org.exolab.castor.xml.MarshalException if object is\r
+ * null or if any SAXException is thrown during marshaling\r
+ * @throws org.exolab.castor.xml.ValidationException if this\r
+ * object is an invalid instance according to the schema\r
+ */\r
+ public void marshal(\r
+ final java.io.Writer out)\r
+ throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
+ Marshaller.marshal(this, out);\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param handler\r
+ * @throws java.io.IOException if an IOException occurs during\r
+ * marshaling\r
+ * @throws org.exolab.castor.xml.ValidationException if this\r
+ * object is an invalid instance according to the schema\r
+ * @throws org.exolab.castor.xml.MarshalException if object is\r
+ * null or if any SAXException is thrown during marshaling\r
+ */\r
+ public void marshal(\r
+ final org.xml.sax.ContentHandler handler)\r
+ throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
+ Marshaller.marshal(this, handler);\r
}\r
\r
- return (Colour) _colourList.get(index);\r
- }\r
-\r
- /**\r
- * Method getColour.Returns the contents of the collection in an Array.\r
- * <p>\r
- * Note: Just in case the collection contents are changing in another thread,\r
- * we pass a 0-length Array of the correct type into the API call. This way we\r
- * <i>know</i> that the Array returned is of exactly the correct length.\r
- * \r
- * @return this collection as an Array\r
- */\r
- public Colour[] getColour()\r
- {\r
- Colour[] array = new Colour[0];\r
- return (Colour[]) this._colourList.toArray(array);\r
- }\r
-\r
- /**\r
- * Method getColourCount.\r
- * \r
- * @return the size of this collection\r
- */\r
- public int getColourCount()\r
- {\r
- return this._colourList.size();\r
- }\r
-\r
- /**\r
- * Returns the value of field 'schemeName'.\r
- * \r
- * @return the value of field 'SchemeName'.\r
- */\r
- public java.lang.String getSchemeName()\r
- {\r
- return this._schemeName;\r
- }\r
-\r
- /**\r
- * Method isValid.\r
- * \r
- * @return true if this object is valid according to the schema\r
- */\r
- public boolean isValid()\r
- {\r
- try\r
- {\r
- validate();\r
- } catch (org.exolab.castor.xml.ValidationException vex)\r
- {\r
- return false;\r
+ /**\r
+ */\r
+ public void removeAllColour(\r
+ ) {\r
+ this._colourList.clear();\r
}\r
- return true;\r
- }\r
-\r
- /**\r
- * \r
- * \r
- * @param out\r
- * @throws org.exolab.castor.xml.MarshalException\r
- * if object is null or if any SAXException is thrown during\r
- * marshaling\r
- * @throws org.exolab.castor.xml.ValidationException\r
- * if this object is an invalid instance according to the\r
- * schema\r
- */\r
- public void marshal(final java.io.Writer out)\r
- throws org.exolab.castor.xml.MarshalException,\r
- org.exolab.castor.xml.ValidationException\r
- {\r
- Marshaller.marshal(this, out);\r
- }\r
-\r
- /**\r
- * \r
- * \r
- * @param handler\r
- * @throws java.io.IOException\r
- * if an IOException occurs during marshaling\r
- * @throws org.exolab.castor.xml.ValidationException\r
- * if this object is an invalid instance according to the\r
- * schema\r
- * @throws org.exolab.castor.xml.MarshalException\r
- * if object is null or if any SAXException is thrown during\r
- * marshaling\r
- */\r
- public void marshal(final org.xml.sax.ContentHandler handler)\r
- throws java.io.IOException,\r
- org.exolab.castor.xml.MarshalException,\r
- org.exolab.castor.xml.ValidationException\r
- {\r
- Marshaller.marshal(this, handler);\r
- }\r
-\r
- /**\r
- */\r
- public void removeAllColour()\r
- {\r
- this._colourList.clear();\r
- }\r
-\r
- /**\r
- * Method removeColour.\r
- * \r
- * @param vColour\r
- * @return true if the object was removed from the collection.\r
- */\r
- public boolean removeColour(final Colour vColour)\r
- {\r
- boolean removed = _colourList.remove(vColour);\r
- return removed;\r
- }\r
-\r
- /**\r
- * Method removeColourAt.\r
- * \r
- * @param index\r
- * @return the element removed from the collection\r
- */\r
- public Colour removeColourAt(final int index)\r
- {\r
- java.lang.Object obj = this._colourList.remove(index);\r
- return (Colour) obj;\r
- }\r
-\r
- /**\r
- * \r
- * \r
- * @param index\r
- * @param vColour\r
- * @throws java.lang.IndexOutOfBoundsException\r
- * if the index given is outside the bounds of the collection\r
- */\r
- public void setColour(final int index, final Colour vColour)\r
- throws java.lang.IndexOutOfBoundsException\r
- {\r
- // check bounds for index\r
- if (index < 0 || index >= this._colourList.size())\r
- {\r
- throw new IndexOutOfBoundsException("setColour: Index value '"\r
- + index + "' not in range [0.."\r
- + (this._colourList.size() - 1) + "]");\r
+\r
+ /**\r
+ * Method removeColour.\r
+ * \r
+ * @param vColour\r
+ * @return true if the object was removed from the collection.\r
+ */\r
+ public boolean removeColour(\r
+ final Colour vColour) {\r
+ boolean removed = _colourList.remove(vColour);\r
+ return removed;\r
+ }\r
+\r
+ /**\r
+ * Method removeColourAt.\r
+ * \r
+ * @param index\r
+ * @return the element removed from the collection\r
+ */\r
+ public Colour removeColourAt(\r
+ final int index) {\r
+ java.lang.Object obj = this._colourList.remove(index);\r
+ return (Colour) obj;\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param index\r
+ * @param vColour\r
+ * @throws java.lang.IndexOutOfBoundsException if the index\r
+ * given is outside the bounds of the collection\r
+ */\r
+ public void setColour(\r
+ final int index,\r
+ final Colour vColour)\r
+ throws java.lang.IndexOutOfBoundsException {\r
+ // check bounds for index\r
+ if (index < 0 || index >= this._colourList.size()) {\r
+ throw new IndexOutOfBoundsException("setColour: Index value '" + index + "' not in range [0.." + (this._colourList.size() - 1) + "]");\r
+ }\r
+ \r
+ this._colourList.set(index, vColour);\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param vColourArray\r
+ */\r
+ public void setColour(\r
+ final Colour[] vColourArray) {\r
+ //-- copy array\r
+ _colourList.clear();\r
+ \r
+ for (int i = 0; i < vColourArray.length; i++) {\r
+ this._colourList.add(vColourArray[i]);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Sets the value of field 'schemeName'.\r
+ * \r
+ * @param schemeName the value of field 'schemeName'.\r
+ */\r
+ public void setSchemeName(\r
+ final java.lang.String schemeName) {\r
+ this._schemeName = schemeName;\r
+ }\r
+\r
+ /**\r
+ * Method unmarshal.\r
+ * \r
+ * @param reader\r
+ * @throws org.exolab.castor.xml.MarshalException if object is\r
+ * null or if any SAXException is thrown during marshaling\r
+ * @throws org.exolab.castor.xml.ValidationException if this\r
+ * object is an invalid instance according to the schema\r
+ * @return the unmarshaled\r
+ * jalview.schemabinding.version2.JalviewUserColours\r
+ */\r
+ public static jalview.schemabinding.version2.JalviewUserColours unmarshal(\r
+ final java.io.Reader reader)\r
+ throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
+ return (jalview.schemabinding.version2.JalviewUserColours) Unmarshaller.unmarshal(jalview.schemabinding.version2.JalviewUserColours.class, reader);\r
}\r
\r
- this._colourList.set(index, vColour);\r
- }\r
-\r
- /**\r
- * \r
- * \r
- * @param vColourArray\r
- */\r
- public void setColour(final Colour[] vColourArray)\r
- {\r
- // -- copy array\r
- _colourList.clear();\r
-\r
- for (int i = 0; i < vColourArray.length; i++)\r
- {\r
- this._colourList.add(vColourArray[i]);\r
+ /**\r
+ * \r
+ * \r
+ * @throws org.exolab.castor.xml.ValidationException if this\r
+ * object is an invalid instance according to the schema\r
+ */\r
+ public void validate(\r
+ )\r
+ throws org.exolab.castor.xml.ValidationException {\r
+ org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
+ validator.validate(this);\r
}\r
- }\r
-\r
- /**\r
- * Sets the value of field 'schemeName'.\r
- * \r
- * @param schemeName\r
- * the value of field 'schemeName'.\r
- */\r
- public void setSchemeName(final java.lang.String schemeName)\r
- {\r
- this._schemeName = schemeName;\r
- }\r
-\r
- /**\r
- * Method unmarshal.\r
- * \r
- * @param reader\r
- * @throws org.exolab.castor.xml.MarshalException\r
- * if object is null or if any SAXException is thrown during\r
- * marshaling\r
- * @throws org.exolab.castor.xml.ValidationException\r
- * if this object is an invalid instance according to the\r
- * schema\r
- * @return the unmarshaled jalview.schemabinding.version2.JalviewUserColours\r
- */\r
- public static jalview.schemabinding.version2.JalviewUserColours unmarshal(\r
- final java.io.Reader reader)\r
- throws org.exolab.castor.xml.MarshalException,\r
- org.exolab.castor.xml.ValidationException\r
- {\r
- return (jalview.schemabinding.version2.JalviewUserColours) Unmarshaller\r
- .unmarshal(\r
- jalview.schemabinding.version2.JalviewUserColours.class,\r
- reader);\r
- }\r
-\r
- /**\r
- * \r
- * \r
- * @throws org.exolab.castor.xml.ValidationException\r
- * if this object is an invalid instance according to the\r
- * schema\r
- */\r
- public void validate() throws org.exolab.castor.xml.ValidationException\r
- {\r
- org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
- validator.validate(this);\r
- }\r
\r
}\r
git://source.jalview.org / jalview.git / blobdiff