applied LGPLv3 and source code formatting.
[vamsas.git] / src / uk / ac / vamsas / objects / core / Seg.java
index 5174b80..5ad851d 100644 (file)
 /*\r
- * This class was automatically generated with \r
- * <a href="http://www.castor.org">Castor 1.1</a>, using an XML\r
- * Schema.\r
- * $Id$\r
+ * This file is part of the Vamsas Client version 0.1. \r
+ * Copyright 2009 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 org.exolab.castor.xml.Marshaller;\r
 import org.exolab.castor.xml.Unmarshaller;\r
 \r
 /**\r
- * a region from start to end, with flag for inclusivity of\r
- *  terminii \r
+ * a region from start to end, with flag for inclusivity of terminii\r
  * \r
  * @version $Revision$ $Date$\r
  */\r
-public class Seg extends uk.ac.vamsas.client.Vobject \r
-implements java.io.Serializable\r
-{\r
-\r
-\r
-      //--------------------------/\r
-     //- Class/Member Variables -/\r
-    //--------------------------/\r
-\r
-    /**\r
-     * Field _start.\r
-     */\r
-    private int _start;\r
-\r
-    /**\r
-     * keeps track of state for field: _start\r
-     */\r
-    private boolean _has_start;\r
-\r
-    /**\r
-     * Field _end.\r
-     */\r
-    private int _end;\r
-\r
-    /**\r
-     * keeps track of state for field: _end\r
-     */\r
-    private boolean _has_end;\r
-\r
-    /**\r
-     * when false, a consecutive range like 'start=1, end=2'\r
-     *  means the region lying after position 1 and before position\r
-     * 2\r
-     *  \r
-     */\r
-    private boolean _inclusive;\r
-\r
-    /**\r
-     * keeps track of state for field: _inclusive\r
-     */\r
-    private boolean _has_inclusive;\r
-\r
-\r
-      //----------------/\r
-     //- Constructors -/\r
-    //----------------/\r
-\r
-    public Seg() {\r
-        super();\r
-    }\r
-\r
-\r
-      //-----------/\r
-     //- Methods -/\r
-    //-----------/\r
-\r
-    /**\r
+public class Seg extends uk.ac.vamsas.client.Vobject implements\r
+    java.io.Serializable {\r
+\r
+  // --------------------------/\r
+  // - Class/Member Variables -/\r
+  // --------------------------/\r
+\r
+  /**\r
+   * Field _start.\r
+   */\r
+  private int _start;\r
+\r
+  /**\r
+   * keeps track of state for field: _start\r
+   */\r
+  private boolean _has_start;\r
+\r
+  /**\r
+   * Field _end.\r
+   */\r
+  private int _end;\r
+\r
+  /**\r
+   * keeps track of state for field: _end\r
+   */\r
+  private boolean _has_end;\r
+\r
+  /**\r
+   * when false, a consecutive range like 'start=1, end=2' means the region\r
+   * lying after position 1 and before position 2\r
+   * \r
+   */\r
+  private boolean _inclusive;\r
+\r
+  /**\r
+   * keeps track of state for field: _inclusive\r
+   */\r
+  private boolean _has_inclusive;\r
+\r
+  // ----------------/\r
+  // - Constructors -/\r
+  // ----------------/\r
+\r
+  public Seg() {\r
+    super();\r
+  }\r
+\r
+  // -----------/\r
+  // - Methods -/\r
+  // -----------/\r
+\r
+  /**\r
      */\r
-    public void deleteEnd(\r
-    ) {\r
-        this._has_end= false;\r
-    }\r
+  public void deleteEnd() {\r
+    this._has_end = false;\r
+  }\r
 \r
-    /**\r
+  /**\r
      */\r
-    public void deleteInclusive(\r
-    ) {\r
-        this._has_inclusive= false;\r
-    }\r
+  public void deleteInclusive() {\r
+    this._has_inclusive = false;\r
+  }\r
 \r
-    /**\r
+  /**\r
      */\r
-    public void deleteStart(\r
-    ) {\r
-        this._has_start= false;\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(\r
-            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 Seg) {\r
-        \r
-            Seg temp = (Seg)obj;\r
-            boolean thcycle;\r
-            boolean tmcycle;\r
-            if (this._start != temp._start)\r
-                return false;\r
-            if (this._has_start != temp._has_start)\r
-                return false;\r
-            if (this._end != temp._end)\r
-                return false;\r
-            if (this._has_end != temp._has_end)\r
-                return false;\r
-            if (this._inclusive != temp._inclusive)\r
-                return false;\r
-            if (this._has_inclusive != temp._has_inclusive)\r
-                return false;\r
-            return true;\r
-        }\r
+  public void deleteStart() {\r
+    this._has_start = false;\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 Seg) {\r
+\r
+      Seg temp = (Seg) obj;\r
+      boolean thcycle;\r
+      boolean tmcycle;\r
+      if (this._start != temp._start)\r
         return false;\r
+      if (this._has_start != temp._has_start)\r
+        return false;\r
+      if (this._end != temp._end)\r
+        return false;\r
+      if (this._has_end != temp._has_end)\r
+        return false;\r
+      if (this._inclusive != temp._inclusive)\r
+        return false;\r
+      if (this._has_inclusive != temp._has_inclusive)\r
+        return false;\r
+      return true;\r
     }\r
-\r
-    /**\r
-     * Returns the value of field 'end'.\r
-     * \r
-     * @return the value of field 'End'.\r
-     */\r
-    public int getEnd(\r
-    ) {\r
-        return this._end;\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 getInclusive(\r
-    ) {\r
-        return this._inclusive;\r
-    }\r
-\r
-    /**\r
-     * Returns the value of field 'start'.\r
-     * \r
-     * @return the value of field 'Start'.\r
-     */\r
-    public int getStart(\r
-    ) {\r
-        return this._start;\r
-    }\r
-\r
-    /**\r
-     * Method hasEnd.\r
-     * \r
-     * @return true if at least one End has been added\r
-     */\r
-    public boolean hasEnd(\r
-    ) {\r
-        return this._has_end;\r
-    }\r
-\r
-    /**\r
-     * Method hasInclusive.\r
-     * \r
-     * @return true if at least one Inclusive has been added\r
-     */\r
-    public boolean hasInclusive(\r
-    ) {\r
-        return this._has_inclusive;\r
-    }\r
-\r
-    /**\r
-     * Method hasStart.\r
-     * \r
-     * @return true if at least one Start has been added\r
-     */\r
-    public boolean hasStart(\r
-    ) {\r
-        return this._has_start;\r
-    }\r
-\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 + _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 true if this object is valid according to the schema\r
-     */\r
-    public boolean isValid(\r
-    ) {\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 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(\r
-            final java.io.Writer out)\r
-    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
-        Marshaller.marshal(this, out);\r
-    }\r
-\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(\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
-    }\r
-\r
-    /**\r
-     * Sets the value of field 'end'.\r
-     * \r
-     * @param end the value of field 'end'.\r
-     */\r
-    public void setEnd(\r
-            final int end) {\r
-        this._end = end;\r
-        this._has_end = true;\r
-    }\r
-\r
-    /**\r
-     * Sets the value of field 'inclusive'. The field 'inclusive'\r
-     * has the following description: when false, a consecutive\r
-     * range like 'start=1, end=2'\r
-     *  means the region lying after position 1 and before position\r
-     * 2\r
-     *  \r
-     * \r
-     * @param inclusive the value of field 'inclusive'.\r
-     */\r
-    public void setInclusive(\r
-            final boolean inclusive) {\r
-        this._inclusive = inclusive;\r
-        this._has_inclusive = true;\r
-    }\r
-\r
-    /**\r
-     * Sets the value of field 'start'.\r
-     * \r
-     * @param start the value of field 'start'.\r
-     */\r
-    public void setStart(\r
-            final int start) {\r
-        this._start = start;\r
-        this._has_start = true;\r
-    }\r
-\r
-    /**\r
-     * Method unmarshal.\r
-     * \r
-     * @param reader\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(\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
-    }\r
-\r
-    /**\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
-    )\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
+    return false;\r
+  }\r
+\r
+  /**\r
+   * Returns the value of field 'end'.\r
+   * \r
+   * @return the value of field 'End'.\r
+   */\r
+  public int getEnd() {\r
+    return this._end;\r
+  }\r
+\r
+  /**\r
+   * Returns the value of field 'inclusive'. The field 'inclusive' has the\r
+   * following description: when false, a consecutive range like 'start=1,\r
+   * end=2' means the region lying after position 1 and before position 2\r
+   * \r
+   * \r
+   * @return the value of field 'Inclusive'.\r
+   */\r
+  public boolean getInclusive() {\r
+    return this._inclusive;\r
+  }\r
+\r
+  /**\r
+   * Returns the value of field 'start'.\r
+   * \r
+   * @return the value of field 'Start'.\r
+   */\r
+  public int getStart() {\r
+    return this._start;\r
+  }\r
+\r
+  /**\r
+   * Method hasEnd.\r
+   * \r
+   * @return true if at least one End has been added\r
+   */\r
+  public boolean hasEnd() {\r
+    return this._has_end;\r
+  }\r
+\r
+  /**\r
+   * Method hasInclusive.\r
+   * \r
+   * @return true if at least one Inclusive has been added\r
+   */\r
+  public boolean hasInclusive() {\r
+    return this._has_inclusive;\r
+  }\r
+\r
+  /**\r
+   * Method hasStart.\r
+   * \r
+   * @return true if at least one Start has been added\r
+   */\r
+  public boolean hasStart() {\r
+    return this._has_start;\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
+    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 'inclusive' has the\r
+   * following description: when false, a consecutive range like 'start=1,\r
+   * end=2' means the region lying after position 1 and before position 2\r
+   * \r
+   * \r
+   * @return the value of field 'Inclusive'.\r
+   */\r
+  public boolean isInclusive() {\r
+    return this._inclusive;\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 'end'.\r
+   * \r
+   * @param end\r
+   *          the value of field 'end'.\r
+   */\r
+  public void setEnd(final int end) {\r
+    this._end = end;\r
+    this._has_end = true;\r
+  }\r
+\r
+  /**\r
+   * Sets the value of field 'inclusive'. The field 'inclusive' has the\r
+   * following description: when false, a consecutive range like 'start=1,\r
+   * end=2' means the region lying after position 1 and before position 2\r
+   * \r
+   * \r
+   * @param inclusive\r
+   *          the value of field 'inclusive'.\r
+   */\r
+  public void setInclusive(final boolean inclusive) {\r
+    this._inclusive = inclusive;\r
+    this._has_inclusive = true;\r
+  }\r
+\r
+  /**\r
+   * Sets the value of field 'start'.\r
+   * \r
+   * @param start\r
+   *          the value of field 'start'.\r
+   */\r
+  public void setStart(final int start) {\r
+    this._start = start;\r
+    this._has_start = true;\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.Seg\r
+   */\r
+  public static uk.ac.vamsas.objects.core.Seg 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.Seg) Unmarshaller.unmarshal(\r
+        uk.ac.vamsas.objects.core.Seg.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