/*\r
- * This class was automatically generated with\r
- * <a href="http://www.castor.org">Castor 0.9.6</a>, using an XML\r
- * Schema.\r
- * $Id$\r
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)\r
+ * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle\r
+ * \r
+ * This file is part of Jalview.\r
+ * \r
+ * Jalview 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 3 of the License, or (at your option) any later version.\r
+ * \r
+ * Jalview is distributed in the hope that it will be useful, but \r
+ * WITHOUT ANY WARRANTY; without even the implied warranty \r
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR \r
+ * PURPOSE. See the GNU General Public License for more details.\r
+ * \r
+ * You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.\r
*/\r
-\r
package jalview.schemabinding.version2;\r
\r
//---------------------------------/\r
//- Imported classes and packages -/\r
//---------------------------------/\r
\r
-import java.util.*;\r
-\r
-import org.exolab.castor.xml.*;\r
+import org.exolab.castor.xml.Marshaller;\r
+import org.exolab.castor.xml.Unmarshaller;\r
\r
/**\r
* Class JalviewUserColours.\r
- *\r
+ * \r
* @version $Revision$ $Date$\r
*/\r
-public class JalviewUserColours\r
- implements java.io.Serializable\r
+public class JalviewUserColours implements java.io.Serializable\r
{\r
\r
- //--------------------------/\r
- //- Class/Member Variables -/\r
- //--------------------------/\r
+ // --------------------------/\r
+ // - Class/Member Variables -/\r
+ // --------------------------/\r
\r
/**\r
- * Field _schemeName\r
+ * Field _schemeName.\r
*/\r
private java.lang.String _schemeName;\r
\r
/**\r
- * Field _colourList\r
+ * Jalview colour scheme document version.\r
+ * \r
+ */\r
+ private java.lang.String _version;\r
+\r
+ /**\r
+ * Field _colourList.\r
*/\r
private java.util.Vector _colourList;\r
\r
- //----------------/\r
- //- Constructors -/\r
- //----------------/\r
+ // ----------------/\r
+ // - Constructors -/\r
+ // ----------------/\r
\r
public JalviewUserColours()\r
{\r
super();\r
- _colourList = new Vector();\r
- } //-- jalview.schemabinding.version2.JalviewUserColours()\r
+ this._colourList = new java.util.Vector();\r
+ }\r
\r
- //-----------/\r
- //- Methods -/\r
- //-----------/\r
+ // -----------/\r
+ // - Methods -/\r
+ // -----------/\r
\r
/**\r
- * Method addColour\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(jalview.schemabinding.version2.Colour vColour)\r
- throws java.lang.IndexOutOfBoundsException\r
+ public void addColour(final Colour vColour)\r
+ throws java.lang.IndexOutOfBoundsException\r
{\r
- _colourList.addElement(vColour);\r
- } //-- void addColour(jalview.schemabinding.version2.Colour)\r
+ this._colourList.addElement(vColour);\r
+ }\r
\r
/**\r
- * Method addColour\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(int index,\r
- jalview.schemabinding.version2.Colour vColour)\r
- throws java.lang.IndexOutOfBoundsException\r
+ public void addColour(final int index, final Colour vColour)\r
+ throws java.lang.IndexOutOfBoundsException\r
{\r
- _colourList.insertElementAt(vColour, index);\r
- } //-- void addColour(int, jalview.schemabinding.version2.Colour)\r
+ this._colourList.add(index, vColour);\r
+ }\r
\r
/**\r
- * Method enumerateColour\r
- *\r
- *\r
- *\r
- * @return Enumeration\r
+ * Method enumerateColour.\r
+ * \r
+ * @return an Enumeration over all Colour elements\r
*/\r
public java.util.Enumeration enumerateColour()\r
{\r
- return _colourList.elements();\r
- } //-- java.util.Enumeration enumerateColour()\r
+ return this._colourList.elements();\r
+ }\r
\r
/**\r
- * Method getColour\r
- *\r
- *\r
- *\r
+ * Method getColour.\r
+ * \r
* @param index\r
- * @return Colour\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 jalview.schemabinding.version2.Colour getColour(int index)\r
- throws java.lang.IndexOutOfBoundsException\r
+ public Colour getColour(final int index)\r
+ throws java.lang.IndexOutOfBoundsException\r
{\r
- //-- check bounds for index\r
- if ( (index < 0) || (index > _colourList.size()))\r
+ // check bounds for index\r
+ if (index < 0 || index >= this._colourList.size())\r
{\r
- throw new IndexOutOfBoundsException();\r
+ throw new IndexOutOfBoundsException("getColour: Index value '"\r
+ + index + "' not in range [0.."\r
+ + (this._colourList.size() - 1) + "]");\r
}\r
\r
- return (jalview.schemabinding.version2.Colour) _colourList.elementAt(index);\r
- } //-- jalview.schemabinding.version2.Colour getColour(int)\r
+ return (Colour) _colourList.get(index);\r
+ }\r
\r
/**\r
- * Method getColour\r
- *\r
- *\r
- *\r
- * @return Colour\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 jalview.schemabinding.version2.Colour[] getColour()\r
+ public Colour[] getColour()\r
{\r
- int size = _colourList.size();\r
- jalview.schemabinding.version2.Colour[] mArray = new jalview.schemabinding.\r
- version2.Colour[size];\r
- for (int index = 0; index < size; index++)\r
- {\r
- mArray[index] = (jalview.schemabinding.version2.Colour) _colourList.\r
- elementAt(index);\r
- }\r
- return mArray;\r
- } //-- jalview.schemabinding.version2.Colour[] getColour()\r
+ Colour[] array = new Colour[0];\r
+ return (Colour[]) this._colourList.toArray(array);\r
+ }\r
\r
/**\r
- * Method getColourCount\r
- *\r
- *\r
- *\r
- * @return int\r
+ * Method getColourCount.\r
+ * \r
+ * @return the size of this collection\r
*/\r
public int getColourCount()\r
{\r
- return _colourList.size();\r
- } //-- int getColourCount()\r
+ return this._colourList.size();\r
+ }\r
\r
/**\r
* Returns the value of field 'schemeName'.\r
- *\r
- * @return String\r
- * @return 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
- } //-- java.lang.String getSchemeName()\r
+ }\r
\r
/**\r
- * Method isValid\r
- *\r
- *\r
- *\r
- * @return boolean\r
+ * Returns the value of field 'version'. The field 'version' has the following\r
+ * description: Jalview colour scheme document version.\r
+ * \r
+ * \r
+ * @return the value of field 'Version'.\r
+ */\r
+ public java.lang.String getVersion()\r
+ {\r
+ return this._version;\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
- }\r
- catch (org.exolab.castor.xml.ValidationException vex)\r
+ } catch (org.exolab.castor.xml.ValidationException vex)\r
{\r
return false;\r
}\r
return true;\r
- } //-- boolean isValid()\r
+ }\r
\r
/**\r
- * Method marshal\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 schema\r
*/\r
- public void marshal(java.io.Writer out)\r
- throws org.exolab.castor.xml.MarshalException,\r
- org.exolab.castor.xml.ValidationException\r
+ public void marshal(final java.io.Writer out)\r
+ throws org.exolab.castor.xml.MarshalException,\r
+ org.exolab.castor.xml.ValidationException\r
{\r
-\r
Marshaller.marshal(this, out);\r
- } //-- void marshal(java.io.Writer)\r
+ }\r
\r
/**\r
- * Method marshal\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 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(org.xml.sax.ContentHandler handler)\r
- throws java.io.IOException, org.exolab.castor.xml.MarshalException,\r
- org.exolab.castor.xml.ValidationException\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
-\r
Marshaller.marshal(this, handler);\r
- } //-- void marshal(org.xml.sax.ContentHandler)\r
+ }\r
\r
/**\r
- * Method removeAllColour\r
- *\r
- */\r
+ */\r
public void removeAllColour()\r
{\r
- _colourList.removeAllElements();\r
- } //-- void removeAllColour()\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 removeColour\r
- *\r
- *\r
- *\r
+ * Method removeColourAt.\r
+ * \r
* @param index\r
- * @return Colour\r
+ * @return the element removed from the collection\r
*/\r
- public jalview.schemabinding.version2.Colour removeColour(int index)\r
+ public Colour removeColourAt(final int index)\r
{\r
- java.lang.Object obj = _colourList.elementAt(index);\r
- _colourList.removeElementAt(index);\r
- return (jalview.schemabinding.version2.Colour) obj;\r
- } //-- jalview.schemabinding.version2.Colour removeColour(int)\r
+ java.lang.Object obj = this._colourList.remove(index);\r
+ return (Colour) obj;\r
+ }\r
\r
/**\r
- * Method setColour\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(int index,\r
- jalview.schemabinding.version2.Colour vColour)\r
- throws java.lang.IndexOutOfBoundsException\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 > _colourList.size()))\r
+ // check bounds for index\r
+ if (index < 0 || index >= this._colourList.size())\r
{\r
- throw new IndexOutOfBoundsException();\r
+ throw new IndexOutOfBoundsException("setColour: Index value '"\r
+ + index + "' not in range [0.."\r
+ + (this._colourList.size() - 1) + "]");\r
}\r
- _colourList.setElementAt(vColour, index);\r
- } //-- void setColour(int, jalview.schemabinding.version2.Colour)\r
+\r
+ this._colourList.set(index, vColour);\r
+ }\r
\r
/**\r
- * Method setColour\r
- *\r
- *\r
- *\r
- * @param colourArray\r
+ * \r
+ * \r
+ * @param vColourArray\r
*/\r
- public void setColour(jalview.schemabinding.version2.Colour[] colourArray)\r
+ public void setColour(final Colour[] vColourArray)\r
{\r
- //-- copy array\r
- _colourList.removeAllElements();\r
- for (int i = 0; i < colourArray.length; i++)\r
+ // -- copy array\r
+ _colourList.clear();\r
+\r
+ for (int i = 0; i < vColourArray.length; i++)\r
{\r
- _colourList.addElement(colourArray[i]);\r
+ this._colourList.add(vColourArray[i]);\r
}\r
- } //-- void setColour(jalview.schemabinding.version2.Colour)\r
+ }\r
\r
/**\r
* Sets the value of field 'schemeName'.\r
- *\r
- * @param schemeName the value of field 'schemeName'.\r
+ * \r
+ * @param schemeName\r
+ * the value of field 'schemeName'.\r
*/\r
- public void setSchemeName(java.lang.String schemeName)\r
+ public void setSchemeName(final java.lang.String schemeName)\r
{\r
this._schemeName = schemeName;\r
- } //-- void setSchemeName(java.lang.String)\r
+ }\r
+\r
+ /**\r
+ * Sets the value of field 'version'. The field 'version' has the following\r
+ * description: Jalview colour scheme document version.\r
+ * \r
+ * \r
+ * @param version\r
+ * the value of field 'version'.\r
+ */\r
+ public void setVersion(final java.lang.String version)\r
+ {\r
+ this._version = version;\r
+ }\r
\r
/**\r
- * Method unmarshal\r
- *\r
- *\r
- *\r
+ * Method unmarshal.\r
+ * \r
* @param reader\r
- * @return Object\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 schema\r
+ * @return the unmarshaled jalview.schemabinding.version2.JalviewUserColours\r
*/\r
- public static java.lang.Object unmarshal(java.io.Reader reader)\r
- throws org.exolab.castor.xml.MarshalException,\r
- org.exolab.castor.xml.ValidationException\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(jalview.schemabinding.version2.JalviewUserColours.class,\r
- reader);\r
- } //-- java.lang.Object unmarshal(java.io.Reader)\r
+ return (jalview.schemabinding.version2.JalviewUserColours) Unmarshaller\r
+ .unmarshal(\r
+ jalview.schemabinding.version2.JalviewUserColours.class,\r
+ reader);\r
+ }\r
\r
/**\r
- * Method validate\r
- *\r
+ * \r
+ * \r
+ * @throws org.exolab.castor.xml.ValidationException\r
+ * if this object is an invalid instance according to the schema\r
*/\r
- public void validate()\r
- throws org.exolab.castor.xml.ValidationException\r
+ public void validate() throws org.exolab.castor.xml.ValidationException\r
{\r
- org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.\r
- Validator();\r
+ org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
validator.validate(this);\r
- } //-- void validate()\r
+ }\r
\r
}\r
git://source.jalview.org / jalview.git / blobdiff