JAL-769
[jalview.git] / src / jalview / schemabinding / version2 / ThresholdLine.java
index ca6d5de..f479c36 100755 (executable)
@@ -1,38 +1,48 @@
 /*\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.6)\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 org.exolab.castor.xml.*;\r
+import org.exolab.castor.xml.Marshaller;\r
+import org.exolab.castor.xml.Unmarshaller;\r
 \r
 /**\r
  * Class ThresholdLine.\r
- *\r
+ * \r
  * @version $Revision$ $Date$\r
  */\r
-public class ThresholdLine\r
-    implements java.io.Serializable\r
+public class ThresholdLine implements java.io.Serializable\r
 {\r
 \r
-  //--------------------------/\r
-  //- Class/Member Variables -/\r
-  //--------------------------/\r
+  // --------------------------/\r
+  // - Class/Member Variables -/\r
+  // --------------------------/\r
 \r
   /**\r
-   * Field _label\r
+   * Field _label.\r
    */\r
   private java.lang.String _label;\r
 \r
   /**\r
-   * Field _value\r
+   * Field _value.\r
    */\r
   private float _value;\r
 \r
@@ -42,7 +52,7 @@ public class ThresholdLine
   private boolean _has_value;\r
 \r
   /**\r
-   * Field _colour\r
+   * Field _colour.\r
    */\r
   private int _colour;\r
 \r
@@ -51,202 +61,203 @@ public class ThresholdLine
    */\r
   private boolean _has_colour;\r
 \r
-  //----------------/\r
-  //- Constructors -/\r
-  //----------------/\r
+  // ----------------/\r
+  // - Constructors -/\r
+  // ----------------/\r
 \r
   public ThresholdLine()\r
   {\r
     super();\r
-  } //-- jalview.schemabinding.version2.ThresholdLine()\r
+  }\r
 \r
-  //-----------/\r
-  //- Methods -/\r
-  //-----------/\r
+  // -----------/\r
+  // - Methods -/\r
+  // -----------/\r
 \r
   /**\r
-   * Method deleteColour\r
-   *\r
-   */\r
+     */\r
   public void deleteColour()\r
   {\r
     this._has_colour = false;\r
-  } //-- void deleteColour()\r
+  }\r
 \r
   /**\r
-   * Method deleteValue\r
-   *\r
-   */\r
+     */\r
   public void deleteValue()\r
   {\r
     this._has_value = false;\r
-  } //-- void deleteValue()\r
+  }\r
 \r
   /**\r
    * Returns the value of field 'colour'.\r
-   *\r
-   * @return int\r
-   * @return the value of field 'colour'.\r
+   * \r
+   * @return the value of field 'Colour'.\r
    */\r
   public int getColour()\r
   {\r
     return this._colour;\r
-  } //-- int getColour()\r
+  }\r
 \r
   /**\r
    * Returns the value of field 'label'.\r
-   *\r
-   * @return String\r
-   * @return the value of field 'label'.\r
+   * \r
+   * @return the value of field 'Label'.\r
    */\r
   public java.lang.String getLabel()\r
   {\r
     return this._label;\r
-  } //-- java.lang.String getLabel()\r
+  }\r
 \r
   /**\r
    * Returns the value of field 'value'.\r
-   *\r
-   * @return float\r
-   * @return the value of field 'value'.\r
+   * \r
+   * @return the value of field 'Value'.\r
    */\r
   public float getValue()\r
   {\r
     return this._value;\r
-  } //-- float getValue()\r
+  }\r
 \r
   /**\r
-   * Method hasColour\r
-   *\r
-   *\r
-   *\r
-   * @return boolean\r
+   * Method hasColour.\r
+   * \r
+   * @return true if at least one Colour has been added\r
    */\r
   public boolean hasColour()\r
   {\r
     return this._has_colour;\r
-  } //-- boolean hasColour()\r
+  }\r
 \r
   /**\r
-   * Method hasValue\r
-   *\r
-   *\r
-   *\r
-   * @return boolean\r
+   * Method hasValue.\r
+   * \r
+   * @return true if at least one Value has been added\r
    */\r
   public boolean hasValue()\r
   {\r
     return this._has_value;\r
-  } //-- boolean hasValue()\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
+   * @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
    * Sets the value of field 'colour'.\r
-   *\r
-   * @param colour the value of field 'colour'.\r
+   * \r
+   * @param colour\r
+   *          the value of field 'colour'.\r
    */\r
-  public void setColour(int colour)\r
+  public void setColour(final int colour)\r
   {\r
     this._colour = colour;\r
     this._has_colour = true;\r
-  } //-- void setColour(int)\r
+  }\r
 \r
   /**\r
    * Sets the value of field 'label'.\r
-   *\r
-   * @param label the value of field 'label'.\r
+   * \r
+   * @param label\r
+   *          the value of field 'label'.\r
    */\r
-  public void setLabel(java.lang.String label)\r
+  public void setLabel(final java.lang.String label)\r
   {\r
     this._label = label;\r
-  } //-- void setLabel(java.lang.String)\r
+  }\r
 \r
   /**\r
    * Sets the value of field 'value'.\r
-   *\r
-   * @param value the value of field 'value'.\r
+   * \r
+   * @param value\r
+   *          the value of field 'value'.\r
    */\r
-  public void setValue(float value)\r
+  public void setValue(final float value)\r
   {\r
     this._value = value;\r
     this._has_value = true;\r
-  } //-- void setValue(float)\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.ThresholdLine\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.ThresholdLine 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.ThresholdLine) Unmarshaller.\r
-        unmarshal(jalview.schemabinding.version2.ThresholdLine.class, reader);\r
-  } //-- java.lang.Object unmarshal(java.io.Reader)\r
+    return (jalview.schemabinding.version2.ThresholdLine) Unmarshaller\r
+            .unmarshal(jalview.schemabinding.version2.ThresholdLine.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