rebult for castor-1.1(vamsas version)
[vamsas.git] / src / uk / ac / vamsas / objects / core / Newick.java
index 7e9f372..23d4f82 100644 (file)
@@ -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;
 
 /**
  * Class Newick.
@@ -41,7 +34,7 @@ implements java.io.Serializable
     private java.lang.String _content = "";
 
     /**
-     * Field _title
+     * Field _title.
      */
     private java.lang.String _title;
 
@@ -52,7 +45,7 @@ implements java.io.Serializable
     private java.lang.String _id;
 
     /**
-     * Field _modifiable
+     * Field _modifiable.
      */
     private java.lang.String _modifiable;
 
@@ -61,11 +54,10 @@ implements java.io.Serializable
      //- Constructors -/
     //----------------/
 
-    public Newick() 
-     {
+    public Newick() {
         super();
         setContent("");
-    } //-- uk.ac.vamsas.objects.core.Newick()
+    }
 
 
       //-----------/
@@ -73,13 +65,13 @@ implements java.io.Serializable
     //-----------/
 
     /**
-     * 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;
         
@@ -120,19 +112,18 @@ implements java.io.Serializable
             return true;
         }
         return false;
-    } //-- boolean equals(java.lang.Object) 
+    }
 
     /**
      * Returns the value of field 'content'. The field 'content'
      * has the following description: internal content storage
      * 
-     * @return String
-     * @return the value of field 'content'.
+     * @return the value of field 'Content'.
      */
-    public java.lang.String getContent()
-    {
+    public java.lang.String getContent(
+    ) {
         return this._content;
-    } //-- java.lang.String getContent() 
+    }
 
     /**
      * Returns the value of field 'id'. The field 'id' has the
@@ -140,81 +131,108 @@ implements java.io.Serializable
      * referencing
      *  
      * 
-     * @return String
-     * @return the value of field 'id'.
+     * @return the value of field 'Id'.
      */
-    public java.lang.String getId()
-    {
+    public java.lang.String getId(
+    ) {
         return this._id;
-    } //-- java.lang.String getId() 
+    }
 
     /**
      * Returns the value of field 'modifiable'.
      * 
-     * @return String
-     * @return the value of field 'modifiable'.
+     * @return the value of field 'Modifiable'.
      */
-    public java.lang.String getModifiable()
-    {
+    public java.lang.String getModifiable(
+    ) {
         return this._modifiable;
-    } //-- java.lang.String getModifiable() 
+    }
 
     /**
      * Returns the value of field 'title'.
      * 
-     * @return String
-     * @return the value of field 'title'.
+     * @return the value of field 'Title'.
      */
-    public java.lang.String getTitle()
-    {
+    public java.lang.String getTitle(
+    ) {
         return this._title;
-    } //-- java.lang.String getTitle() 
+    }
 
     /**
-     * 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;
+        if (_content != null) {
+           result = 37 * result + _content.hashCode();
+        }
+        if (_title != null) {
+           result = 37 * result + _title.hashCode();
+        }
+        if (_id != null) {
+           result = 37 * result + _id.hashCode();
+        }
+        if (_modifiable != null) {
+           result = 37 * result + _modifiable.hashCode();
+        }
+        
+        return result;
+    }
+
+    /**
+     * 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 'content'. The field 'content' has
@@ -222,10 +240,10 @@ implements java.io.Serializable
      * 
      * @param content the value of field 'content'.
      */
-    public void setContent(java.lang.String content)
-    {
+    public void setContent(
+            final java.lang.String content) {
         this._content = content;
-    } //-- void setContent(java.lang.String) 
+    }
 
     /**
      * Sets the value of field 'id'. The field 'id' has the
@@ -235,54 +253,58 @@ implements java.io.Serializable
      * 
      * @param id the value of field 'id'.
      */
-    public void setId(java.lang.String id)
-    {
+    public void setId(
+            final java.lang.String id) {
         this._id = id;
-    } //-- void setId(java.lang.String) 
+    }
 
     /**
      * Sets the value of field 'modifiable'.
      * 
      * @param modifiable the value of field 'modifiable'.
      */
-    public void setModifiable(java.lang.String modifiable)
-    {
+    public void setModifiable(
+            final java.lang.String modifiable) {
         this._modifiable = modifiable;
-    } //-- void setModifiable(java.lang.String) 
+    }
 
     /**
      * Sets the value of field 'title'.
      * 
      * @param title the value of field 'title'.
      */
-    public void setTitle(java.lang.String title)
-    {
+    public void setTitle(
+            final java.lang.String title) {
         this._title = title;
-    } //-- void setTitle(java.lang.String) 
+    }
 
     /**
-     * Method unmarshal
-     * 
-     * 
+     * Method unmarshal.
      * 
      * @param reader
-     * @return Newick
+     * @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.Newick
      */
-    public static uk.ac.vamsas.objects.core.Newick unmarshal(java.io.Reader reader)
-        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
-    {
+    public static uk.ac.vamsas.objects.core.Newick unmarshal(
+            final java.io.Reader reader)
+    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
         return (uk.ac.vamsas.objects.core.Newick) Unmarshaller.unmarshal(uk.ac.vamsas.objects.core.Newick.class, reader);
-    } //-- uk.ac.vamsas.objects.core.Newick 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() 
+    }
 
 }