/*\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.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
*/\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.*;\r
+import org.exolab.castor.xml.Marshaller;\r
+import org.exolab.castor.xml.Unmarshaller;\r
\r
/**\r
* Class AnnotationColours.\r
- *\r
+ * \r
* @version $Revision$ $Date$\r
*/\r
-public class AnnotationColours\r
- implements java.io.Serializable\r
+public class AnnotationColours implements java.io.Serializable\r
{\r
\r
- //--------------------------/\r
- //- Class/Member Variables -/\r
- //--------------------------/\r
+ // --------------------------/\r
+ // - Class/Member Variables -/\r
+ // --------------------------/\r
\r
/**\r
- * Field _aboveThreshold\r
+ * Field _aboveThreshold.\r
*/\r
private int _aboveThreshold;\r
\r
private boolean _has_aboveThreshold;\r
\r
/**\r
- * Field _annotation\r
+ * Field _annotation.\r
*/\r
private java.lang.String _annotation;\r
\r
/**\r
- * Field _minColour\r
+ * Field _minColour.\r
*/\r
private int _minColour;\r
\r
private boolean _has_minColour;\r
\r
/**\r
- * Field _maxColour\r
+ * Field _maxColour.\r
*/\r
private int _maxColour;\r
\r
private boolean _has_maxColour;\r
\r
/**\r
- * Field _colourScheme\r
+ * Field _colourScheme.\r
*/\r
private java.lang.String _colourScheme;\r
\r
/**\r
- * Field _threshold\r
+ * Field _threshold.\r
*/\r
private float _threshold;\r
\r
*/\r
private boolean _has_threshold;\r
\r
- //----------------/\r
- //- Constructors -/\r
- //----------------/\r
+ // ----------------/\r
+ // - Constructors -/\r
+ // ----------------/\r
\r
public AnnotationColours()\r
{\r
super();\r
- } //-- jalview.schemabinding.version2.AnnotationColours()\r
+ }\r
\r
- //-----------/\r
- //- Methods -/\r
- //-----------/\r
+ // -----------/\r
+ // - Methods -/\r
+ // -----------/\r
\r
/**\r
- * Method deleteAboveThreshold\r
- *\r
*/\r
public void deleteAboveThreshold()\r
{\r
this._has_aboveThreshold = false;\r
- } //-- void deleteAboveThreshold()\r
+ }\r
\r
/**\r
- * Method deleteMaxColour\r
- *\r
*/\r
public void deleteMaxColour()\r
{\r
this._has_maxColour = false;\r
- } //-- void deleteMaxColour()\r
+ }\r
\r
/**\r
- * Method deleteMinColour\r
- *\r
*/\r
public void deleteMinColour()\r
{\r
this._has_minColour = false;\r
- } //-- void deleteMinColour()\r
+ }\r
\r
/**\r
- * Method deleteThreshold\r
- *\r
*/\r
public void deleteThreshold()\r
{\r
this._has_threshold = false;\r
- } //-- void deleteThreshold()\r
+ }\r
\r
/**\r
* Returns the value of field 'aboveThreshold'.\r
- *\r
- * @return int\r
- * @return the value of field 'aboveThreshold'.\r
+ * \r
+ * @return the value of field 'AboveThreshold'.\r
*/\r
public int getAboveThreshold()\r
{\r
return this._aboveThreshold;\r
- } //-- int getAboveThreshold()\r
+ }\r
\r
/**\r
* Returns the value of field 'annotation'.\r
- *\r
- * @return String\r
- * @return the value of field 'annotation'.\r
+ * \r
+ * @return the value of field 'Annotation'.\r
*/\r
public java.lang.String getAnnotation()\r
{\r
return this._annotation;\r
- } //-- java.lang.String getAnnotation()\r
+ }\r
\r
/**\r
* Returns the value of field 'colourScheme'.\r
- *\r
- * @return String\r
- * @return the value of field 'colourScheme'.\r
+ * \r
+ * @return the value of field 'ColourScheme'.\r
*/\r
public java.lang.String getColourScheme()\r
{\r
return this._colourScheme;\r
- } //-- java.lang.String getColourScheme()\r
+ }\r
\r
/**\r
* Returns the value of field 'maxColour'.\r
- *\r
- * @return int\r
- * @return the value of field 'maxColour'.\r
+ * \r
+ * @return the value of field 'MaxColour'.\r
*/\r
public int getMaxColour()\r
{\r
return this._maxColour;\r
- } //-- int getMaxColour()\r
+ }\r
\r
/**\r
* Returns the value of field 'minColour'.\r
- *\r
- * @return int\r
- * @return the value of field 'minColour'.\r
+ * \r
+ * @return the value of field 'MinColour'.\r
*/\r
public int getMinColour()\r
{\r
return this._minColour;\r
- } //-- int getMinColour()\r
+ }\r
\r
/**\r
* Returns the value of field 'threshold'.\r
- *\r
- * @return float\r
- * @return the value of field 'threshold'.\r
+ * \r
+ * @return the value of field 'Threshold'.\r
*/\r
public float getThreshold()\r
{\r
return this._threshold;\r
- } //-- float getThreshold()\r
+ }\r
\r
/**\r
- * Method hasAboveThreshold\r
- *\r
- *\r
- *\r
- * @return boolean\r
+ * Method hasAboveThreshold.\r
+ * \r
+ * @return true if at least one AboveThreshold has been added\r
*/\r
public boolean hasAboveThreshold()\r
{\r
return this._has_aboveThreshold;\r
- } //-- boolean hasAboveThreshold()\r
+ }\r
\r
/**\r
- * Method hasMaxColour\r
- *\r
- *\r
- *\r
- * @return boolean\r
+ * Method hasMaxColour.\r
+ * \r
+ * @return true if at least one MaxColour has been added\r
*/\r
public boolean hasMaxColour()\r
{\r
return this._has_maxColour;\r
- } //-- boolean hasMaxColour()\r
+ }\r
\r
/**\r
- * Method hasMinColour\r
- *\r
- *\r
- *\r
- * @return boolean\r
+ * Method hasMinColour.\r
+ * \r
+ * @return true if at least one MinColour has been added\r
*/\r
public boolean hasMinColour()\r
{\r
return this._has_minColour;\r
- } //-- boolean hasMinColour()\r
+ }\r
\r
/**\r
- * Method hasThreshold\r
- *\r
- *\r
- *\r
- * @return boolean\r
+ * Method hasThreshold.\r
+ * \r
+ * @return true if at least one Threshold has been added\r
*/\r
public boolean hasThreshold()\r
{\r
return this._has_threshold;\r
- } //-- boolean hasThreshold()\r
+ }\r
\r
/**\r
- * Method isValid\r
- *\r
- *\r
- *\r
- * @return boolean\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
- */\r
- public void marshal(java.io.Writer out)\r
- throws org.exolab.castor.xml.MarshalException,\r
- org.exolab.castor.xml.ValidationException\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
-\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
- */\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
+ * @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
-\r
Marshaller.marshal(this, handler);\r
- } //-- void marshal(org.xml.sax.ContentHandler)\r
+ }\r
\r
/**\r
* Sets the value of field 'aboveThreshold'.\r
- *\r
- * @param aboveThreshold the value of field 'aboveThreshold'.\r
+ * \r
+ * @param aboveThreshold\r
+ * the value of field 'aboveThreshold'.\r
*/\r
- public void setAboveThreshold(int aboveThreshold)\r
+ public void setAboveThreshold(final int aboveThreshold)\r
{\r
this._aboveThreshold = aboveThreshold;\r
this._has_aboveThreshold = true;\r
- } //-- void setAboveThreshold(int)\r
+ }\r
\r
/**\r
* Sets the value of field 'annotation'.\r
- *\r
- * @param annotation the value of field 'annotation'.\r
+ * \r
+ * @param annotation\r
+ * the value of field 'annotation'.\r
*/\r
- public void setAnnotation(java.lang.String annotation)\r
+ public void setAnnotation(final java.lang.String annotation)\r
{\r
this._annotation = annotation;\r
- } //-- void setAnnotation(java.lang.String)\r
+ }\r
\r
/**\r
* Sets the value of field 'colourScheme'.\r
- *\r
- * @param colourScheme the value of field 'colourScheme'.\r
+ * \r
+ * @param colourScheme\r
+ * the value of field 'colourScheme'.\r
*/\r
- public void setColourScheme(java.lang.String colourScheme)\r
+ public void setColourScheme(final java.lang.String colourScheme)\r
{\r
this._colourScheme = colourScheme;\r
- } //-- void setColourScheme(java.lang.String)\r
+ }\r
\r
/**\r
* Sets the value of field 'maxColour'.\r
- *\r
- * @param maxColour the value of field 'maxColour'.\r
+ * \r
+ * @param maxColour\r
+ * the value of field 'maxColour'.\r
*/\r
- public void setMaxColour(int maxColour)\r
+ public void setMaxColour(final int maxColour)\r
{\r
this._maxColour = maxColour;\r
this._has_maxColour = true;\r
- } //-- void setMaxColour(int)\r
+ }\r
\r
/**\r
* Sets the value of field 'minColour'.\r
- *\r
- * @param minColour the value of field 'minColour'.\r
+ * \r
+ * @param minColour\r
+ * the value of field 'minColour'.\r
*/\r
- public void setMinColour(int minColour)\r
+ public void setMinColour(final int minColour)\r
{\r
this._minColour = minColour;\r
this._has_minColour = true;\r
- } //-- void setMinColour(int)\r
+ }\r
\r
/**\r
* Sets the value of field 'threshold'.\r
- *\r
- * @param threshold the value of field 'threshold'.\r
+ * \r
+ * @param threshold\r
+ * the value of field 'threshold'.\r
*/\r
- public void setThreshold(float threshold)\r
+ public void setThreshold(final float threshold)\r
{\r
this._threshold = threshold;\r
this._has_threshold = true;\r
- } //-- void setThreshold(float)\r
+ }\r
\r
/**\r
- * Method unmarshal\r
- *\r
- *\r
- *\r
+ * Method unmarshal.\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
+ * @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.AnnotationColours\r
+ */\r
+ public static jalview.schemabinding.version2.AnnotationColours 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.AnnotationColours) Unmarshaller.\r
- unmarshal(jalview.schemabinding.version2.AnnotationColours.class,\r
- reader);\r
- } //-- java.lang.Object unmarshal(java.io.Reader)\r
+ return (jalview.schemabinding.version2.AnnotationColours) Unmarshaller\r
+ .unmarshal(\r
+ jalview.schemabinding.version2.AnnotationColours.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\r
+ * 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