X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fuk%2Fac%2Fvamsas%2Fobjects%2Fcore%2FSeg.java;h=4a7c031f30f9eba47d243c3758c0a3b7c30d964b;hb=261406f42435f46617fb9efe7c5472b5f670ff42;hp=e6d0d1bebf0c2f9901cb1486214d991dc52fe8b6;hpb=a06295cc0912455e0bc53b26cb4e0134e6759d0f;p=vamsas.git

diff --git a/src/uk/ac/vamsas/objects/core/Seg.java b/src/uk/ac/vamsas/objects/core/Seg.java
index e6d0d1b..4a7c031 100644
--- a/src/uk/ac/vamsas/objects/core/Seg.java
+++ b/src/uk/ac/vamsas/objects/core/Seg.java
@@ -1,6 +1,6 @@
 /*
  * This class was automatically generated with 
- * <a href="http://www.castor.org">Castor 0.9.9M2</a>, using an XML
+ * <a href="http://www.castor.org">Castor 1.1</a>, using an XML
  * Schema.
  * $Id$
  */
@@ -11,15 +11,8 @@ package uk.ac.vamsas.objects.core;
  //- Imported classes and packages -/
 //---------------------------------/
 
-import java.io.IOException;
-import java.io.Reader;
-import java.io.Serializable;
-import java.io.Writer;
-import org.exolab.castor.xml.MarshalException;
 import org.exolab.castor.xml.Marshaller;
 import org.exolab.castor.xml.Unmarshaller;
-import org.exolab.castor.xml.ValidationException;
-import org.xml.sax.ContentHandler;
 
 /**
  * a region from start to end, with flag for inclusivity of
@@ -37,7 +30,7 @@ implements java.io.Serializable
     //--------------------------/
 
     /**
-     * Field _start
+     * Field _start.
      */
     private int _start;
 
@@ -47,7 +40,7 @@ implements java.io.Serializable
     private boolean _has_start;
 
     /**
-     * Field _end
+     * Field _end.
      */
     private int _end;
 
@@ -74,10 +67,9 @@ implements java.io.Serializable
      //- Constructors -/
     //----------------/
 
-    public Seg() 
-     {
+    public Seg() {
         super();
-    } //-- uk.ac.vamsas.objects.core.Seg()
+    }
 
 
       //-----------/
@@ -85,40 +77,34 @@ implements java.io.Serializable
     //-----------/
 
     /**
-     * Method deleteEnd
-     * 
      */
-    public void deleteEnd()
-    {
+    public void deleteEnd(
+    ) {
         this._has_end= false;
-    } //-- void deleteEnd() 
+    }
 
     /**
-     * Method deleteInclusive
-     * 
      */
-    public void deleteInclusive()
-    {
+    public void deleteInclusive(
+    ) {
         this._has_inclusive= false;
-    } //-- void deleteInclusive() 
+    }
 
     /**
-     * Method deleteStart
-     * 
      */
-    public void deleteStart()
-    {
+    public void deleteStart(
+    ) {
         this._has_start= false;
-    } //-- void deleteStart() 
+    }
 
     /**
-     * Note: hashCode() has not been overriden
+     * Overrides the java.lang.Object.equals method.
      * 
      * @param obj
-     * @return boolean
+     * @return true if the objects are equal.
      */
-    public boolean equals(java.lang.Object obj)
-    {
+    public boolean equals(
+            final java.lang.Object obj) {
         if ( this == obj )
             return true;
         
@@ -143,18 +129,17 @@ implements java.io.Serializable
             return true;
         }
         return false;
-    } //-- boolean equals(java.lang.Object) 
+    }
 
     /**
      * Returns the value of field 'end'.
      * 
-     * @return int
-     * @return the value of field 'end'.
+     * @return the value of field 'End'.
      */
-    public int getEnd()
-    {
+    public int getEnd(
+    ) {
         return this._end;
-    } //-- int getEnd() 
+    }
 
     /**
      * Returns the value of field 'inclusive'. The field
@@ -164,117 +149,145 @@ implements java.io.Serializable
      * 2
      *  
      * 
-     * @return boolean
-     * @return the value of field 'inclusive'.
+     * @return the value of field 'Inclusive'.
      */
-    public boolean getInclusive()
-    {
+    public boolean getInclusive(
+    ) {
         return this._inclusive;
-    } //-- boolean getInclusive() 
+    }
 
     /**
      * Returns the value of field 'start'.
      * 
-     * @return int
-     * @return the value of field 'start'.
+     * @return the value of field 'Start'.
      */
-    public int getStart()
-    {
+    public int getStart(
+    ) {
         return this._start;
-    } //-- int getStart() 
+    }
 
     /**
-     * Method hasEnd
-     * 
+     * Method hasEnd.
      * 
-     * 
-     * @return boolean
+     * @return true if at least one End has been added
      */
-    public boolean hasEnd()
-    {
+    public boolean hasEnd(
+    ) {
         return this._has_end;
-    } //-- boolean hasEnd() 
+    }
 
     /**
-     * Method hasInclusive
-     * 
+     * Method hasInclusive.
      * 
-     * 
-     * @return boolean
+     * @return true if at least one Inclusive has been added
      */
-    public boolean hasInclusive()
-    {
+    public boolean hasInclusive(
+    ) {
         return this._has_inclusive;
-    } //-- boolean hasInclusive() 
+    }
 
     /**
-     * Method hasStart
-     * 
+     * Method hasStart.
      * 
-     * 
-     * @return boolean
+     * @return true if at least one Start has been added
      */
-    public boolean hasStart()
-    {
+    public boolean hasStart(
+    ) {
         return this._has_start;
-    } //-- boolean hasStart() 
+    }
 
     /**
-     * Method isValid
+     * Overrides the java.lang.Object.hashCode method.
+     * <p>
+     * The following steps came from <b>Effective Java Programming
+     * Language Guide</b> by Joshua Bloch, Chapter 3
      * 
+     * @return a hash code value for the object.
+     */
+    public int hashCode(
+    ) {
+        int result = super.hashCode();
+        
+        long tmp;
+        result = 37 * result + _start;
+        result = 37 * result + _end;
+        result = 37 * result + (_inclusive?0:1);
+        
+        return result;
+    }
+
+    /**
+     * Returns the value of field 'inclusive'. The field
+     * 'inclusive' has the following description: when false, a
+     * consecutive range like 'start=1, end=2'
+     *  means the region lying after position 1 and before position
+     * 2
+     *  
      * 
+     * @return the value of field 'Inclusive'.
+     */
+    public boolean isInclusive(
+    ) {
+        return this._inclusive;
+    }
+
+    /**
+     * Method isValid.
      * 
-     * @return boolean
+     * @return true if this object is valid according to the schema
      */
-    public boolean isValid()
-    {
+    public boolean isValid(
+    ) {
         try {
             validate();
-        }
-        catch (org.exolab.castor.xml.ValidationException vex) {
+        } catch (org.exolab.castor.xml.ValidationException vex) {
             return false;
         }
         return true;
-    } //-- boolean isValid() 
+    }
 
     /**
-     * Method marshal
-     * 
      * 
      * 
      * @param out
+     * @throws org.exolab.castor.xml.MarshalException if object is
+     * null or if any SAXException is thrown during marshaling
+     * @throws org.exolab.castor.xml.ValidationException if this
+     * object is an invalid instance according to the schema
      */
-    public void marshal(java.io.Writer out)
-        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
-    {
-        
+    public void marshal(
+            final java.io.Writer out)
+    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
         Marshaller.marshal(this, out);
-    } //-- void marshal(java.io.Writer) 
+    }
 
     /**
-     * Method marshal
-     * 
      * 
      * 
      * @param handler
+     * @throws java.io.IOException if an IOException occurs during
+     * marshaling
+     * @throws org.exolab.castor.xml.ValidationException if this
+     * object is an invalid instance according to the schema
+     * @throws org.exolab.castor.xml.MarshalException if object is
+     * null or if any SAXException is thrown during marshaling
      */
-    public void marshal(org.xml.sax.ContentHandler handler)
-        throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
-    {
-        
+    public void marshal(
+            final org.xml.sax.ContentHandler handler)
+    throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
         Marshaller.marshal(this, handler);
-    } //-- void marshal(org.xml.sax.ContentHandler) 
+    }
 
     /**
      * Sets the value of field 'end'.
      * 
      * @param end the value of field 'end'.
      */
-    public void setEnd(int end)
-    {
+    public void setEnd(
+            final int end) {
         this._end = end;
         this._has_end = true;
-    } //-- void setEnd(int) 
+    }
 
     /**
      * Sets the value of field 'inclusive'. The field 'inclusive'
@@ -286,46 +299,50 @@ implements java.io.Serializable
      * 
      * @param inclusive the value of field 'inclusive'.
      */
-    public void setInclusive(boolean inclusive)
-    {
+    public void setInclusive(
+            final boolean inclusive) {
         this._inclusive = inclusive;
         this._has_inclusive = true;
-    } //-- void setInclusive(boolean) 
+    }
 
     /**
      * Sets the value of field 'start'.
      * 
      * @param start the value of field 'start'.
      */
-    public void setStart(int start)
-    {
+    public void setStart(
+            final int start) {
         this._start = start;
         this._has_start = true;
-    } //-- void setStart(int) 
+    }
 
     /**
-     * Method unmarshal
-     * 
-     * 
+     * Method unmarshal.
      * 
      * @param reader
-     * @return Seg
+     * @throws org.exolab.castor.xml.MarshalException if object is
+     * null or if any SAXException is thrown during marshaling
+     * @throws org.exolab.castor.xml.ValidationException if this
+     * object is an invalid instance according to the schema
+     * @return the unmarshaled uk.ac.vamsas.objects.core.Seg
      */
-    public static uk.ac.vamsas.objects.core.Seg unmarshal(java.io.Reader reader)
-        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
-    {
+    public static uk.ac.vamsas.objects.core.Seg unmarshal(
+            final java.io.Reader reader)
+    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
         return (uk.ac.vamsas.objects.core.Seg) Unmarshaller.unmarshal(uk.ac.vamsas.objects.core.Seg.class, reader);
-    } //-- uk.ac.vamsas.objects.core.Seg unmarshal(java.io.Reader) 
+    }
 
     /**
-     * Method validate
      * 
+     * 
+     * @throws org.exolab.castor.xml.ValidationException if this
+     * object is an invalid instance according to the schema
      */
-    public void validate()
-        throws org.exolab.castor.xml.ValidationException
-    {
+    public void validate(
+    )
+    throws org.exolab.castor.xml.ValidationException {
         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
         validator.validate(this);
-    } //-- void validate() 
+    }
 
 }