-/*\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
- */\r
-/*\r
-* Jalview - A Sequence Alignment Editor and Viewer\r
-* Copyright (C) 2005 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
-*/\r
-package jalview.binding;\r
-\r
-import org.exolab.castor.xml.MarshalException;\r
-import org.exolab.castor.xml.Marshaller;\r
-import org.exolab.castor.xml.Unmarshaller;\r
-import org.exolab.castor.xml.ValidationException;\r
-\r
-import org.xml.sax.ContentHandler;\r
-\r
-//---------------------------------/\r
-//- Imported classes and packages -/\r
-//---------------------------------/\r
-import java.io.IOException;\r
-import java.io.Reader;\r
-import java.io.Serializable;\r
-import java.io.Writer;\r
-\r
-import java.util.Enumeration;\r
-import java.util.Vector;\r
-\r
-\r
-/**\r
- * Class JalviewUserColours.\r
- *\r
- * @version $Revision$ $Date$\r
- */\r
-public class JalviewUserColours implements java.io.Serializable {\r
- //--------------------------/\r
- //- Class/Member Variables -/\r
- //--------------------------/\r
-\r
- /**\r
- * Field _colourList\r
- */\r
- private java.util.Vector _colourList;\r
-\r
- //----------------/\r
- //- Constructors -/\r
- //----------------/\r
- public JalviewUserColours() {\r
- super();\r
- _colourList = new Vector();\r
- }\r
- //-- jalview.binding.JalviewUserColours()\r
- //-----------/\r
-\r
- public void addColour(jalview.binding.Colour vColour)\r
- throws java.lang.IndexOutOfBoundsException {\r
- _colourList.addElement(vColour);\r
- }\r
- //-- void addColour(jalview.binding.Colour)\r
-\r
- /**\r
- * Method addColour\r
- *\r
- *\r
- *\r
- * @param index\r
- * @param vColour\r
- */\r
- public void addColour(int index, jalview.binding.Colour vColour)\r
- throws java.lang.IndexOutOfBoundsException {\r
- _colourList.insertElementAt(vColour, index);\r
- }\r
- //-- void addColour(int, jalview.binding.Colour)\r
-\r
- /**\r
- * Method enumerateColour\r
- *\r
- *\r
- *\r
- * @return Enumeration\r
- */\r
- public java.util.Enumeration enumerateColour() {\r
- return _colourList.elements();\r
- }\r
- //-- java.util.Enumeration enumerateColour()\r
-\r
- /**\r
- * Method getColour\r
- *\r
- *\r
- *\r
- * @param index\r
- * @return Colour\r
- */\r
- public jalview.binding.Colour getColour(int index)\r
- throws java.lang.IndexOutOfBoundsException {\r
- //-- check bounds for index\r
- if ((index < 0) || (index > _colourList.size())) {\r
- throw new IndexOutOfBoundsException();\r
- }\r
-\r
- return (jalview.binding.Colour) _colourList.elementAt(index);\r
- }\r
- //-- jalview.binding.Colour getColour(int)\r
-\r
- /**\r
- * Method getColour\r
- *\r
- *\r
- *\r
- * @return Colour\r
- */\r
- public jalview.binding.Colour[] getColour() {\r
- int size = _colourList.size();\r
- jalview.binding.Colour[] mArray = new jalview.binding.Colour[size];\r
-\r
- for (int index = 0; index < size; index++) {\r
- mArray[index] = (jalview.binding.Colour) _colourList.elementAt(index);\r
- }\r
-\r
- return mArray;\r
- }\r
- //-- jalview.binding.Colour[] getColour()\r
-\r
- /**\r
- * Method getColourCount\r
- *\r
- *\r
- *\r
- * @return int\r
- */\r
- public int getColourCount() {\r
- return _colourList.size();\r
- }\r
- //-- int getColourCount()\r
-\r
- /**\r
- * Method isValid\r
- *\r
- *\r
- *\r
- * @return boolean\r
- */\r
- public boolean isValid() {\r
- try {\r
- validate();\r
- } catch (org.exolab.castor.xml.ValidationException vex) {\r
- return false;\r
- }\r
-\r
- return true;\r
- }\r
- //-- boolean isValid()\r
-\r
- /**\r
- * Method marshal\r
- *\r
- *\r
- *\r
- * @param out\r
- */\r
- public void marshal(java.io.Writer out)\r
- throws org.exolab.castor.xml.MarshalException, \r
- org.exolab.castor.xml.ValidationException {\r
- Marshaller.marshal(this, out);\r
- }\r
- //-- void marshal(java.io.Writer)\r
-\r
- /**\r
- * Method marshal\r
- *\r
- *\r
- *\r
- * @param handler\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
- Marshaller.marshal(this, handler);\r
- }\r
- //-- void marshal(org.xml.sax.ContentHandler)\r
-\r
- /**\r
- * Method removeAllColour\r
- *\r
- */\r
- public void removeAllColour() {\r
- _colourList.removeAllElements();\r
- }\r
- //-- void removeAllColour()\r
-\r
- /**\r
- * Method removeColour\r
- *\r
- *\r
- *\r
- * @param index\r
- * @return Colour\r
- */\r
- public jalview.binding.Colour removeColour(int index) {\r
- java.lang.Object obj = _colourList.elementAt(index);\r
- _colourList.removeElementAt(index);\r
-\r
- return (jalview.binding.Colour) obj;\r
- }\r
- //-- jalview.binding.Colour removeColour(int)\r
-\r
- /**\r
- * Method setColour\r
- *\r
- *\r
- *\r
- * @param index\r
- * @param vColour\r
- */\r
- public void setColour(int index, jalview.binding.Colour vColour)\r
- throws java.lang.IndexOutOfBoundsException {\r
- //-- check bounds for index\r
- if ((index < 0) || (index > _colourList.size())) {\r
- throw new IndexOutOfBoundsException();\r
- }\r
-\r
- _colourList.setElementAt(vColour, index);\r
- }\r
- //-- void setColour(int, jalview.binding.Colour)\r
-\r
- /**\r
- * Method setColour\r
- *\r
- *\r
- *\r
- * @param colourArray\r
- */\r
- public void setColour(jalview.binding.Colour[] colourArray) {\r
- //-- copy array\r
- _colourList.removeAllElements();\r
-\r
- for (int i = 0; i < colourArray.length; i++) {\r
- _colourList.addElement(colourArray[i]);\r
- }\r
- }\r
- //-- void setColour(jalview.binding.Colour)\r
-\r
- /**\r
- * Method unmarshal\r
- *\r
- *\r
- *\r
- * @param reader\r
- * @return Object\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
- return (jalview.binding.JalviewUserColours) Unmarshaller.unmarshal(jalview.binding.JalviewUserColours.class,\r
- reader);\r
- }\r
- //-- java.lang.Object unmarshal(java.io.Reader)\r
-\r
- /**\r
- * Method validate\r
- *\r
- */\r
- public void validate() 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
- //-- void validate()\r
-}\r
+/*******************************************************************************
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
+ * Copyright (C) 2011 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 <http://www.gnu.org/licenses/>.
+ *******************************************************************************/
+/*
+ * This class was automatically generated with
+ * <a href="http://www.castor.org">Castor 1.1</a>, using an XML
+ * Schema.
+ * $Id$
+ */
+
+package jalview.binding;
+
+ //---------------------------------/
+ //- Imported classes and packages -/
+//---------------------------------/
+
+import org.exolab.castor.xml.Marshaller;
+import org.exolab.castor.xml.Unmarshaller;
+
+/**
+ * Class JalviewUserColours.
+ *
+ * @version $Revision$ $Date$
+ */
+public class JalviewUserColours implements java.io.Serializable {
+
+
+ //--------------------------/
+ //- Class/Member Variables -/
+ //--------------------------/
+
+ /**
+ * Field _schemeName.
+ */
+ private java.lang.String _schemeName;
+
+ /**
+ * Jalview colour scheme document version.
+ *
+ */
+ private java.lang.String _version;
+
+ /**
+ * Field _colourList.
+ */
+ private java.util.Vector _colourList;
+
+
+ //----------------/
+ //- Constructors -/
+ //----------------/
+
+ public JalviewUserColours() {
+ super();
+ this._colourList = new java.util.Vector();
+ }
+
+
+ //-----------/
+ //- Methods -/
+ //-----------/
+
+ /**
+ *
+ *
+ * @param vColour
+ * @throws java.lang.IndexOutOfBoundsException if the index
+ * given is outside the bounds of the collection
+ */
+ public void addColour(
+ final Colour vColour)
+ throws java.lang.IndexOutOfBoundsException {
+ this._colourList.addElement(vColour);
+ }
+
+ /**
+ *
+ *
+ * @param index
+ * @param vColour
+ * @throws java.lang.IndexOutOfBoundsException if the index
+ * given is outside the bounds of the collection
+ */
+ public void addColour(
+ final int index,
+ final Colour vColour)
+ throws java.lang.IndexOutOfBoundsException {
+ this._colourList.add(index, vColour);
+ }
+
+ /**
+ * Method enumerateColour.
+ *
+ * @return an Enumeration over all Colour elements
+ */
+ public java.util.Enumeration enumerateColour(
+ ) {
+ return this._colourList.elements();
+ }
+
+ /**
+ * Method getColour.
+ *
+ * @param index
+ * @throws java.lang.IndexOutOfBoundsException if the index
+ * given is outside the bounds of the collection
+ * @return the value of the Colour at the given index
+ */
+ public Colour getColour(
+ final int index)
+ throws java.lang.IndexOutOfBoundsException {
+ // check bounds for index
+ if (index < 0 || index >= this._colourList.size()) {
+ throw new IndexOutOfBoundsException("getColour: Index value '" + index + "' not in range [0.." + (this._colourList.size() - 1) + "]");
+ }
+
+ return (Colour) _colourList.get(index);
+ }
+
+ /**
+ * Method getColour.Returns the contents of the collection in
+ * an Array. <p>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 <i>know</i>
+ * that the Array returned is of exactly the correct length.
+ *
+ * @return this collection as an Array
+ */
+ public Colour[] getColour(
+ ) {
+ Colour[] array = new Colour[0];
+ return (Colour[]) this._colourList.toArray(array);
+ }
+
+ /**
+ * Method getColourCount.
+ *
+ * @return the size of this collection
+ */
+ public int getColourCount(
+ ) {
+ return this._colourList.size();
+ }
+
+ /**
+ * Returns the value of field 'schemeName'.
+ *
+ * @return the value of field 'SchemeName'.
+ */
+ public java.lang.String getSchemeName(
+ ) {
+ return this._schemeName;
+ }
+
+ /**
+ * Returns the value of field 'version'. The field 'version'
+ * has the following description: Jalview colour scheme
+ * document version.
+ *
+ *
+ * @return the value of field 'Version'.
+ */
+ public java.lang.String getVersion(
+ ) {
+ return this._version;
+ }
+
+ /**
+ * 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 removeAllColour(
+ ) {
+ this._colourList.clear();
+ }
+
+ /**
+ * Method removeColour.
+ *
+ * @param vColour
+ * @return true if the object was removed from the collection.
+ */
+ public boolean removeColour(
+ final Colour vColour) {
+ boolean removed = _colourList.remove(vColour);
+ return removed;
+ }
+
+ /**
+ * Method removeColourAt.
+ *
+ * @param index
+ * @return the element removed from the collection
+ */
+ public Colour removeColourAt(
+ final int index) {
+ java.lang.Object obj = this._colourList.remove(index);
+ return (Colour) obj;
+ }
+
+ /**
+ *
+ *
+ * @param index
+ * @param vColour
+ * @throws java.lang.IndexOutOfBoundsException if the index
+ * given is outside the bounds of the collection
+ */
+ public void setColour(
+ final int index,
+ final Colour vColour)
+ throws java.lang.IndexOutOfBoundsException {
+ // check bounds for index
+ if (index < 0 || index >= this._colourList.size()) {
+ throw new IndexOutOfBoundsException("setColour: Index value '" + index + "' not in range [0.." + (this._colourList.size() - 1) + "]");
+ }
+
+ this._colourList.set(index, vColour);
+ }
+
+ /**
+ *
+ *
+ * @param vColourArray
+ */
+ public void setColour(
+ final Colour[] vColourArray) {
+ //-- copy array
+ _colourList.clear();
+
+ for (int i = 0; i < vColourArray.length; i++) {
+ this._colourList.add(vColourArray[i]);
+ }
+ }
+
+ /**
+ * Sets the value of field 'schemeName'.
+ *
+ * @param schemeName the value of field 'schemeName'.
+ */
+ public void setSchemeName(
+ final java.lang.String schemeName) {
+ this._schemeName = schemeName;
+ }
+
+ /**
+ * Sets the value of field 'version'. The field 'version' has
+ * the following description: Jalview colour scheme document
+ * version.
+ *
+ *
+ * @param version the value of field 'version'.
+ */
+ public void setVersion(
+ final java.lang.String version) {
+ this._version = version;
+ }
+
+ /**
+ * 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.binding.JalviewUserColours
+ */
+ public static jalview.binding.JalviewUserColours unmarshal(
+ final java.io.Reader reader)
+ throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
+ return (jalview.binding.JalviewUserColours) Unmarshaller.unmarshal(jalview.binding.JalviewUserColours.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);
+ }
+
+}
git://source.jalview.org / jalview.git / blobdiff