rebult for castor-1.1(vamsas version)
[vamsas.git] / src / uk / ac / vamsas / objects / core / Score.java
index bb00fa4..8448198 100644 (file)
@@ -1,6 +1,6 @@
 /*\r
  * This class was automatically generated with \r
- * <a href="http://www.castor.org">Castor 0.9.9M2</a>, using an XML\r
+ * <a href="http://www.castor.org">Castor 1.1</a>, using an XML\r
  * Schema.\r
  * $Id$\r
  */\r
@@ -11,15 +11,8 @@ package uk.ac.vamsas.objects.core;
  //- Imported classes and packages -/\r
 //---------------------------------/\r
 \r
-import java.io.IOException;\r
-import java.io.Reader;\r
-import java.io.Serializable;\r
-import java.io.Writer;\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
-import org.xml.sax.ContentHandler;\r
 \r
 /**\r
  * Ordered set of optionally named float values for the\r
@@ -47,7 +40,7 @@ implements java.io.Serializable
     private boolean _has_content;\r
 \r
     /**\r
-     * Field _name\r
+     * Field _name.\r
      */\r
     private java.lang.String _name = "score";\r
 \r
@@ -56,11 +49,10 @@ implements java.io.Serializable
      //- Constructors -/\r
     //----------------/\r
 \r
-    public Score() \r
-     {\r
+    public Score() {\r
         super();\r
         setName("score");\r
-    } //-- uk.ac.vamsas.objects.core.Score()\r
+    }\r
 \r
 \r
       //-----------/\r
@@ -68,22 +60,20 @@ implements java.io.Serializable
     //-----------/\r
 \r
     /**\r
-     * Method deleteContent\r
-     * \r
      */\r
-    public void deleteContent()\r
-    {\r
+    public void deleteContent(\r
+    ) {\r
         this._has_content= false;\r
-    } //-- void deleteContent() \r
+    }\r
 \r
     /**\r
-     * Note: hashCode() has not been overriden\r
+     * Overrides the java.lang.Object.equals method.\r
      * \r
      * @param obj\r
-     * @return boolean\r
+     * @return true if the objects are equal.\r
      */\r
-    public boolean equals(java.lang.Object obj)\r
-    {\r
+    public boolean equals(\r
+            final java.lang.Object obj) {\r
         if ( this == obj )\r
             return true;\r
         \r
@@ -107,88 +97,106 @@ implements java.io.Serializable
             return true;\r
         }\r
         return false;\r
-    } //-- boolean equals(java.lang.Object) \r
+    }\r
 \r
     /**\r
      * Returns the value of field 'content'. The field 'content'\r
      * has the following description: internal content storage\r
      * \r
-     * @return float\r
-     * @return the value of field 'content'.\r
+     * @return the value of field 'Content'.\r
      */\r
-    public float getContent()\r
-    {\r
+    public float getContent(\r
+    ) {\r
         return this._content;\r
-    } //-- float getContent() \r
+    }\r
 \r
     /**\r
      * Returns the value of field 'name'.\r
      * \r
-     * @return String\r
-     * @return the value of field 'name'.\r
+     * @return the value of field 'Name'.\r
      */\r
-    public java.lang.String getName()\r
-    {\r
+    public java.lang.String getName(\r
+    ) {\r
         return this._name;\r
-    } //-- java.lang.String getName() \r
+    }\r
 \r
     /**\r
-     * Method hasContent\r
-     * \r
-     * \r
+     * Method hasContent.\r
      * \r
-     * @return boolean\r
+     * @return true if at least one Content has been added\r
      */\r
-    public boolean hasContent()\r
-    {\r
+    public boolean hasContent(\r
+    ) {\r
         return this._has_content;\r
-    } //-- boolean hasContent() \r
+    }\r
 \r
     /**\r
-     * Method isValid\r
-     * \r
+     * Overrides the java.lang.Object.hashCode method.\r
+     * <p>\r
+     * The following steps came from <b>Effective Java Programming\r
+     * Language Guide</b> by Joshua Bloch, Chapter 3\r
      * \r
+     * @return a hash code value for the object.\r
+     */\r
+    public int hashCode(\r
+    ) {\r
+        int result = super.hashCode();\r
+        \r
+        long tmp;\r
+        result = 37 * result + java.lang.Float.floatToIntBits(_content);\r
+        if (_name != null) {\r
+           result = 37 * result + _name.hashCode();\r
+        }\r
+        \r
+        return result;\r
+    }\r
+\r
+    /**\r
+     * Method isValid.\r
      * \r
-     * @return boolean\r
+     * @return true if this object is valid according to the schema\r
      */\r
-    public boolean isValid()\r
-    {\r
+    public boolean isValid(\r
+    ) {\r
         try {\r
             validate();\r
-        }\r
-        catch (org.exolab.castor.xml.ValidationException vex) {\r
+        } catch (org.exolab.castor.xml.ValidationException vex) {\r
             return false;\r
         }\r
         return true;\r
-    } //-- boolean isValid() \r
+    }\r
 \r
     /**\r
-     * Method marshal\r
-     * \r
      * \r
      * \r
      * @param out\r
+     * @throws org.exolab.castor.xml.MarshalException if object is\r
+     * null or if any SAXException is thrown during marshaling\r
+     * @throws org.exolab.castor.xml.ValidationException if this\r
+     * 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, org.exolab.castor.xml.ValidationException\r
-    {\r
-        \r
+    public void marshal(\r
+            final java.io.Writer out)\r
+    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
         Marshaller.marshal(this, out);\r
-    } //-- void marshal(java.io.Writer) \r
+    }\r
 \r
     /**\r
-     * Method marshal\r
-     * \r
      * \r
      * \r
      * @param handler\r
+     * @throws java.io.IOException if an IOException occurs during\r
+     * marshaling\r
+     * @throws org.exolab.castor.xml.ValidationException if this\r
+     * object is an invalid instance according to the schema\r
+     * @throws org.exolab.castor.xml.MarshalException if object is\r
+     * null or if any SAXException is thrown during marshaling\r
      */\r
-    public void marshal(org.xml.sax.ContentHandler handler)\r
-        throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
-    {\r
-        \r
+    public void marshal(\r
+            final org.xml.sax.ContentHandler handler)\r
+    throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
         Marshaller.marshal(this, handler);\r
-    } //-- void marshal(org.xml.sax.ContentHandler) \r
+    }\r
 \r
     /**\r
      * Sets the value of field 'content'. The field 'content' has\r
@@ -196,45 +204,49 @@ implements java.io.Serializable
      * \r
      * @param content the value of field 'content'.\r
      */\r
-    public void setContent(float content)\r
-    {\r
+    public void setContent(\r
+            final float content) {\r
         this._content = content;\r
         this._has_content = true;\r
-    } //-- void setContent(float) \r
+    }\r
 \r
     /**\r
      * Sets the value of field 'name'.\r
      * \r
      * @param name the value of field 'name'.\r
      */\r
-    public void setName(java.lang.String name)\r
-    {\r
+    public void setName(\r
+            final java.lang.String name) {\r
         this._name = name;\r
-    } //-- void setName(java.lang.String) \r
+    }\r
 \r
     /**\r
-     * Method unmarshal\r
-     * \r
-     * \r
+     * Method unmarshal.\r
      * \r
      * @param reader\r
-     * @return Score\r
+     * @throws org.exolab.castor.xml.MarshalException if object is\r
+     * null or if any SAXException is thrown during marshaling\r
+     * @throws org.exolab.castor.xml.ValidationException if this\r
+     * object is an invalid instance according to the schema\r
+     * @return the unmarshaled uk.ac.vamsas.objects.core.Score\r
      */\r
-    public static uk.ac.vamsas.objects.core.Score unmarshal(java.io.Reader reader)\r
-        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
-    {\r
+    public static uk.ac.vamsas.objects.core.Score unmarshal(\r
+            final java.io.Reader reader)\r
+    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
         return (uk.ac.vamsas.objects.core.Score) Unmarshaller.unmarshal(uk.ac.vamsas.objects.core.Score.class, reader);\r
-    } //-- uk.ac.vamsas.objects.core.Score unmarshal(java.io.Reader) \r
+    }\r
 \r
     /**\r
-     * Method validate\r
      * \r
+     * \r
+     * @throws org.exolab.castor.xml.ValidationException if this\r
+     * object is an invalid instance according to the schema\r
      */\r
-    public void validate()\r
-        throws org.exolab.castor.xml.ValidationException\r
-    {\r
+    public void validate(\r
+    )\r
+    throws org.exolab.castor.xml.ValidationException {\r
         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
         validator.validate(this);\r
-    } //-- void validate() \r
+    }\r
 \r
 }\r