verson 0.2 LGPL licensed source and jars
[vamsas.git] / src / uk / ac / vamsas / objects / core / Instance.java
index 6b7bfe5..b04b427 100644 (file)
 /*\r
- * This class was automatically generated with \r
- * <a href="http://www.castor.org">Castor 0.9.9M2</a>, using an XML\r
- * Schema.\r
- * $Id$\r
+ * This file is part of the Vamsas Client version 0.2. \r
+ * Copyright 2010 by Jim Procter, Iain Milne, Pierre Marguerite, \r
+ *  Andrew Waterhouse and Dominik Lindner.\r
+ * \r
+ * Earlier versions have also been incorporated into Jalview version 2.4 \r
+ * since 2008, and TOPALi version 2 since 2007.\r
+ * \r
+ * The Vamsas Client is free software: you can redistribute it and/or modify\r
+ * it under the terms of the GNU Lesser General Public License as published by\r
+ * the Free Software Foundation, either version 3 of the License, or\r
+ * (at your option) any later version.\r
+ *  \r
+ * The Vamsas Client is distributed in the hope that it will be useful,\r
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
+ * GNU Lesser General Public License for more details.\r
+ * \r
+ * You should have received a copy of the GNU Lesser General Public License\r
+ * along with the Vamsas Client.  If not, see <http://www.gnu.org/licenses/>.\r
  */\r
-\r
 package uk.ac.vamsas.objects.core;\r
 \r
-  //---------------------------------/\r
- //- Imported classes and packages -/\r
+//---------------------------------/\r
+//- 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
  * Class Instance.\r
  * \r
  * @version $Revision$ $Date$\r
  */\r
-public class Instance extends uk.ac.vamsas.objects.core.AppData \r
-implements java.io.Serializable\r
-{\r
-\r
-\r
-      //--------------------------/\r
-     //- Class/Member Variables -/\r
-    //--------------------------/\r
-\r
-    /**\r
-     * Field _urn\r
-     */\r
-    private java.lang.String _urn;\r
-\r
-\r
-      //----------------/\r
-     //- Constructors -/\r
-    //----------------/\r
-\r
-    public Instance() \r
-     {\r
-        super();\r
-    } //-- uk.ac.vamsas.objects.core.Instance()\r
-\r
-\r
-      //-----------/\r
-     //- Methods -/\r
-    //-----------/\r
-\r
-    /**\r
-     * Note: hashCode() has not been overriden\r
-     * \r
-     * @param obj\r
-     * @return boolean\r
-     */\r
-    public boolean equals(java.lang.Object obj)\r
-    {\r
-        if ( this == obj )\r
-            return true;\r
-        \r
-        if (super.equals(obj)==false)\r
+public class Instance extends uk.ac.vamsas.objects.core.AppData implements\r
+    java.io.Serializable {\r
+\r
+  // --------------------------/\r
+  // - Class/Member Variables -/\r
+  // --------------------------/\r
+\r
+  /**\r
+   * Field _urn.\r
+   */\r
+  private java.lang.String _urn;\r
+\r
+  // ----------------/\r
+  // - Constructors -/\r
+  // ----------------/\r
+\r
+  public Instance() {\r
+    super();\r
+  }\r
+\r
+  // -----------/\r
+  // - Methods -/\r
+  // -----------/\r
+\r
+  /**\r
+   * Overrides the java.lang.Object.equals method.\r
+   * \r
+   * @param obj\r
+   * @return true if the objects are equal.\r
+   */\r
+  public boolean equals(final java.lang.Object obj) {\r
+    if (this == obj)\r
+      return true;\r
+\r
+    if (super.equals(obj) == false)\r
+      return false;\r
+\r
+    if (obj instanceof Instance) {\r
+\r
+      Instance temp = (Instance) obj;\r
+      boolean thcycle;\r
+      boolean tmcycle;\r
+      if (this._urn != null) {\r
+        if (temp._urn == null)\r
+          return false;\r
+        if (this._urn != temp._urn) {\r
+          thcycle = org.castor.util.CycleBreaker.startingToCycle(this._urn);\r
+          tmcycle = org.castor.util.CycleBreaker.startingToCycle(temp._urn);\r
+          if (thcycle != tmcycle) {\r
+            if (!thcycle) {\r
+              org.castor.util.CycleBreaker.releaseCycleHandle(this._urn);\r
+            }\r
+            ;\r
+            if (!tmcycle) {\r
+              org.castor.util.CycleBreaker.releaseCycleHandle(temp._urn);\r
+            }\r
+            ;\r
             return false;\r
-        \r
-        if (obj instanceof Instance) {\r
-        \r
-            Instance temp = (Instance)obj;\r
-            if (this._urn != null) {\r
-                if (temp._urn == null) return false;\r
-                else if (!(this._urn.equals(temp._urn))) \r
-                    return false;\r
+          }\r
+          if (!thcycle) {\r
+            if (!this._urn.equals(temp._urn)) {\r
+              org.castor.util.CycleBreaker.releaseCycleHandle(this._urn);\r
+              org.castor.util.CycleBreaker.releaseCycleHandle(temp._urn);\r
+              return false;\r
             }\r
-            else if (temp._urn != null)\r
-                return false;\r
-            return true;\r
+            org.castor.util.CycleBreaker.releaseCycleHandle(this._urn);\r
+            org.castor.util.CycleBreaker.releaseCycleHandle(temp._urn);\r
+          }\r
         }\r
+      } else if (temp._urn != null)\r
         return false;\r
-    } //-- boolean equals(java.lang.Object) \r
-\r
-    /**\r
-     * Returns the value of field 'urn'.\r
-     * \r
-     * @return String\r
-     * @return the value of field 'urn'.\r
-     */\r
-    public java.lang.String getUrn()\r
-    {\r
-        return this._urn;\r
-    } //-- java.lang.String getUrn() \r
-\r
-    /**\r
-     * Method isValid\r
-     * \r
-     * \r
-     * \r
-     * @return boolean\r
-     */\r
-    public boolean isValid()\r
-    {\r
-        try {\r
-            validate();\r
-        }\r
-        catch (org.exolab.castor.xml.ValidationException vex) {\r
-            return false;\r
-        }\r
-        return true;\r
-    } //-- boolean isValid() \r
-\r
-    /**\r
-     * Method marshal\r
-     * \r
-     * \r
-     * \r
-     * @param out\r
-     */\r
-    public void marshal(java.io.Writer out)\r
-        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
-    {\r
-        \r
-        Marshaller.marshal(this, out);\r
-    } //-- void marshal(java.io.Writer) \r
-\r
-    /**\r
-     * Method marshal\r
-     * \r
-     * \r
-     * \r
-     * @param handler\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
-        Marshaller.marshal(this, handler);\r
-    } //-- void marshal(org.xml.sax.ContentHandler) \r
-\r
-    /**\r
-     * Sets the value of field 'urn'.\r
-     * \r
-     * @param urn the value of field 'urn'.\r
-     */\r
-    public void setUrn(java.lang.String urn)\r
-    {\r
-        this._urn = urn;\r
-    } //-- void setUrn(java.lang.String) \r
-\r
-    /**\r
-     * Method unmarshal\r
-     * \r
-     * \r
-     * \r
-     * @param reader\r
-     * @return AppData\r
-     */\r
-    public static uk.ac.vamsas.objects.core.AppData unmarshal(java.io.Reader reader)\r
-        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
-    {\r
-        return (uk.ac.vamsas.objects.core.Instance) Unmarshaller.unmarshal(uk.ac.vamsas.objects.core.Instance.class, reader);\r
-    } //-- uk.ac.vamsas.objects.core.AppData unmarshal(java.io.Reader) \r
-\r
-    /**\r
-     * Method validate\r
-     * \r
-     */\r
-    public void validate()\r
-        throws org.exolab.castor.xml.ValidationException\r
-    {\r
-        org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
-        validator.validate(this);\r
-    } //-- void validate() \r
+      return true;\r
+    }\r
+    return false;\r
+  }\r
+\r
+  /**\r
+   * Returns the value of field 'urn'.\r
+   * \r
+   * @return the value of field 'Urn'.\r
+   */\r
+  public java.lang.String getUrn() {\r
+    return this._urn;\r
+  }\r
+\r
+  /**\r
+   * Overrides the java.lang.Object.hashCode method.\r
+   * <p>\r
+   * The following steps came from <b>Effective Java Programming Language\r
+   * Guide</b> by Joshua Bloch, Chapter 3\r
+   * \r
+   * @return a hash code value for the object.\r
+   */\r
+  public int hashCode() {\r
+    int result = super.hashCode();\r
+\r
+    long tmp;\r
+    if (_urn != null && !org.castor.util.CycleBreaker.startingToCycle(_urn)) {\r
+      result = 37 * result + _urn.hashCode();\r
+      org.castor.util.CycleBreaker.releaseCycleHandle(_urn);\r
+    }\r
+\r
+    return result;\r
+  }\r
+\r
+  /**\r
+   * Method isValid.\r
+   * \r
+   * @return true if this object is valid according to the schema\r
+   */\r
+  public boolean isValid() {\r
+    try {\r
+      validate();\r
+    } catch (org.exolab.castor.xml.ValidationException vex) {\r
+      return false;\r
+    }\r
+    return true;\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(final java.io.Writer out)\r
+      throws org.exolab.castor.xml.MarshalException,\r
+      org.exolab.castor.xml.ValidationException {\r
+    Marshaller.marshal(this, out);\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(final org.xml.sax.ContentHandler handler)\r
+      throws java.io.IOException, org.exolab.castor.xml.MarshalException,\r
+      org.exolab.castor.xml.ValidationException {\r
+    Marshaller.marshal(this, handler);\r
+  }\r
+\r
+  /**\r
+   * Sets the value of field 'urn'.\r
+   * \r
+   * @param urn\r
+   *          the value of field 'urn'.\r
+   */\r
+  public void setUrn(final java.lang.String urn) {\r
+    this._urn = urn;\r
+  }\r
+\r
+  /**\r
+   * Method unmarshal.\r
+   * \r
+   * @param reader\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 uk.ac.vamsas.objects.core.AppData\r
+   */\r
+  public static uk.ac.vamsas.objects.core.AppData unmarshal(\r
+      final java.io.Reader reader)\r
+      throws org.exolab.castor.xml.MarshalException,\r
+      org.exolab.castor.xml.ValidationException {\r
+    return (uk.ac.vamsas.objects.core.AppData) Unmarshaller.unmarshal(\r
+        uk.ac.vamsas.objects.core.Instance.class, reader);\r
+  }\r
+\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() throws org.exolab.castor.xml.ValidationException {\r
+    org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
+    validator.validate(this);\r
+  }\r
 \r
 }\r