rebult for castor-1.1(vamsas version)
[vamsas.git] / src / uk / ac / vamsas / objects / core / Seg.java
index e6d0d1b..4a7c031 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
  * a region from start to end, with flag for inclusivity of\r
@@ -37,7 +30,7 @@ implements java.io.Serializable
     //--------------------------/\r
 \r
     /**\r
-     * Field _start\r
+     * Field _start.\r
      */\r
     private int _start;\r
 \r
@@ -47,7 +40,7 @@ implements java.io.Serializable
     private boolean _has_start;\r
 \r
     /**\r
-     * Field _end\r
+     * Field _end.\r
      */\r
     private int _end;\r
 \r
@@ -74,10 +67,9 @@ implements java.io.Serializable
      //- Constructors -/\r
     //----------------/\r
 \r
-    public Seg() \r
-     {\r
+    public Seg() {\r
         super();\r
-    } //-- uk.ac.vamsas.objects.core.Seg()\r
+    }\r
 \r
 \r
       //-----------/\r
@@ -85,40 +77,34 @@ implements java.io.Serializable
     //-----------/\r
 \r
     /**\r
-     * Method deleteEnd\r
-     * \r
      */\r
-    public void deleteEnd()\r
-    {\r
+    public void deleteEnd(\r
+    ) {\r
         this._has_end= false;\r
-    } //-- void deleteEnd() \r
+    }\r
 \r
     /**\r
-     * Method deleteInclusive\r
-     * \r
      */\r
-    public void deleteInclusive()\r
-    {\r
+    public void deleteInclusive(\r
+    ) {\r
         this._has_inclusive= false;\r
-    } //-- void deleteInclusive() \r
+    }\r
 \r
     /**\r
-     * Method deleteStart\r
-     * \r
      */\r
-    public void deleteStart()\r
-    {\r
+    public void deleteStart(\r
+    ) {\r
         this._has_start= false;\r
-    } //-- void deleteStart() \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
@@ -143,18 +129,17 @@ 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 'end'.\r
      * \r
-     * @return int\r
-     * @return the value of field 'end'.\r
+     * @return the value of field 'End'.\r
      */\r
-    public int getEnd()\r
-    {\r
+    public int getEnd(\r
+    ) {\r
         return this._end;\r
-    } //-- int getEnd() \r
+    }\r
 \r
     /**\r
      * Returns the value of field 'inclusive'. The field\r
@@ -164,117 +149,145 @@ implements java.io.Serializable
      * 2\r
      *  \r
      * \r
-     * @return boolean\r
-     * @return the value of field 'inclusive'.\r
+     * @return the value of field 'Inclusive'.\r
      */\r
-    public boolean getInclusive()\r
-    {\r
+    public boolean getInclusive(\r
+    ) {\r
         return this._inclusive;\r
-    } //-- boolean getInclusive() \r
+    }\r
 \r
     /**\r
      * Returns the value of field 'start'.\r
      * \r
-     * @return int\r
-     * @return the value of field 'start'.\r
+     * @return the value of field 'Start'.\r
      */\r
-    public int getStart()\r
-    {\r
+    public int getStart(\r
+    ) {\r
         return this._start;\r
-    } //-- int getStart() \r
+    }\r
 \r
     /**\r
-     * Method hasEnd\r
-     * \r
+     * Method hasEnd.\r
      * \r
-     * \r
-     * @return boolean\r
+     * @return true if at least one End has been added\r
      */\r
-    public boolean hasEnd()\r
-    {\r
+    public boolean hasEnd(\r
+    ) {\r
         return this._has_end;\r
-    } //-- boolean hasEnd() \r
+    }\r
 \r
     /**\r
-     * Method hasInclusive\r
-     * \r
+     * Method hasInclusive.\r
      * \r
-     * \r
-     * @return boolean\r
+     * @return true if at least one Inclusive has been added\r
      */\r
-    public boolean hasInclusive()\r
-    {\r
+    public boolean hasInclusive(\r
+    ) {\r
         return this._has_inclusive;\r
-    } //-- boolean hasInclusive() \r
+    }\r
 \r
     /**\r
-     * Method hasStart\r
-     * \r
+     * Method hasStart.\r
      * \r
-     * \r
-     * @return boolean\r
+     * @return true if at least one Start has been added\r
      */\r
-    public boolean hasStart()\r
-    {\r
+    public boolean hasStart(\r
+    ) {\r
         return this._has_start;\r
-    } //-- boolean hasStart() \r
+    }\r
 \r
     /**\r
-     * Method isValid\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 + _start;\r
+        result = 37 * result + _end;\r
+        result = 37 * result + (_inclusive?0:1);\r
+        \r
+        return result;\r
+    }\r
+\r
+    /**\r
+     * Returns the value of field 'inclusive'. The field\r
+     * 'inclusive' has the following description: when false, a\r
+     * consecutive range like 'start=1, end=2'\r
+     *  means the region lying after position 1 and before position\r
+     * 2\r
+     *  \r
      * \r
+     * @return the value of field 'Inclusive'.\r
+     */\r
+    public boolean isInclusive(\r
+    ) {\r
+        return this._inclusive;\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 'end'.\r
      * \r
      * @param end the value of field 'end'.\r
      */\r
-    public void setEnd(int end)\r
-    {\r
+    public void setEnd(\r
+            final int end) {\r
         this._end = end;\r
         this._has_end = true;\r
-    } //-- void setEnd(int) \r
+    }\r
 \r
     /**\r
      * Sets the value of field 'inclusive'. The field 'inclusive'\r
@@ -286,46 +299,50 @@ implements java.io.Serializable
      * \r
      * @param inclusive the value of field 'inclusive'.\r
      */\r
-    public void setInclusive(boolean inclusive)\r
-    {\r
+    public void setInclusive(\r
+            final boolean inclusive) {\r
         this._inclusive = inclusive;\r
         this._has_inclusive = true;\r
-    } //-- void setInclusive(boolean) \r
+    }\r
 \r
     /**\r
      * Sets the value of field 'start'.\r
      * \r
      * @param start the value of field 'start'.\r
      */\r
-    public void setStart(int start)\r
-    {\r
+    public void setStart(\r
+            final int start) {\r
         this._start = start;\r
         this._has_start = true;\r
-    } //-- void setStart(int) \r
+    }\r
 \r
     /**\r
-     * Method unmarshal\r
-     * \r
-     * \r
+     * Method unmarshal.\r
      * \r
      * @param reader\r
-     * @return Seg\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.Seg\r
      */\r
-    public static uk.ac.vamsas.objects.core.Seg 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.Seg 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.Seg) Unmarshaller.unmarshal(uk.ac.vamsas.objects.core.Seg.class, reader);\r
-    } //-- uk.ac.vamsas.objects.core.Seg 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