/*\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
+ * 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 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
+ * This file is part of Jalview.\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
+ * 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
- * 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
+ * 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
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
private java.lang.String _schemeName;\r
\r
/**\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
* @param vColour\r
* @throws java.lang.IndexOutOfBoundsException\r
- * if the index given is outside the bounds of the collection\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
* @param index\r
* @param vColour\r
* @throws java.lang.IndexOutOfBoundsException\r
- * if the index given is outside the bounds of the collection\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
* @param index\r
* @throws java.lang.IndexOutOfBoundsException\r
- * if the index given is outside the bounds of the collection\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
}\r
\r
/**\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
* @param out\r
* @throws org.exolab.castor.xml.MarshalException\r
- * if object is null or if any SAXException is thrown during\r
- * marshaling\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
+ * if this object is an invalid instance according to the schema\r
*/\r
public void marshal(final java.io.Writer out)\r
throws org.exolab.castor.xml.MarshalException,\r
* \r
* @param handler\r
* @throws java.io.IOException\r
- * if an IOException occurs during marshaling\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
+ * 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
+ * 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
}\r
\r
/**\r
- */\r
+ */\r
public void removeAllColour()\r
{\r
this._colourList.clear();\r
* @param index\r
* @param vColour\r
* @throws java.lang.IndexOutOfBoundsException\r
- * if the index given is outside the bounds of the collection\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
* Sets the value of field 'schemeName'.\r
* \r
* @param schemeName\r
- * the value of field 'schemeName'.\r
+ * the value of field 'schemeName'.\r
*/\r
public void setSchemeName(final java.lang.String schemeName)\r
{\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
* @param reader\r
* @throws org.exolab.castor.xml.MarshalException\r
- * if object is null or if any SAXException is thrown during\r
- * marshaling\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
+ * if this object is an invalid instance according to the schema\r
* @return the unmarshaled jalview.schemabinding.version2.JalviewUserColours\r
*/\r
public static jalview.schemabinding.version2.JalviewUserColours unmarshal(\r
* \r
* \r
* @throws org.exolab.castor.xml.ValidationException\r
- * if this object is an invalid instance according to the\r
- * schema\r
+ * if this object is an invalid instance according to the schema\r
*/\r
public void validate() throws org.exolab.castor.xml.ValidationException\r
{\r
git://source.jalview.org / jalview.git / blobdiff