GPL license added
[jalview.git] / src / jalview / binding / Annotation.java
index fefdd12..4af694f 100755 (executable)
@@ -1,10 +1,29 @@
 /*\r
- * This class was automatically generated with \r
+ * This class was automatically generated with\r
  * <a href="http://www.castor.org">Castor 0.9.6</a>, using an XML\r
  * Schema.\r
  * $Id$\r
  */\r
 \r
+/*\r
+* Jalview - A Sequence Alignment Editor and Viewer\r
+* Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
+*\r
+* This program is free software; you can redistribute it and/or\r
+* modify it under the terms of the GNU General Public License\r
+* as published by the Free Software Foundation; either version 2\r
+* of the License, or (at your option) any later version.\r
+*\r
+* This program 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 General Public License for more details.\r
+*\r
+* You should have received a copy of the GNU General Public License\r
+* along with this program; if not, write to the Free Software\r
+* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
+*/\r
+\r
 package jalview.binding;\r
 \r
   //---------------------------------/\r
@@ -25,7 +44,7 @@ import org.xml.sax.ContentHandler;
 \r
 /**\r
  * Class Annotation.\r
- * \r
+ *\r
  * @version $Revision$ $Date$\r
  */\r
 public class Annotation implements java.io.Serializable {\r
@@ -77,22 +96,22 @@ public class Annotation implements java.io.Serializable {
 \r
     /**\r
      * Method addAnnotationElement\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param vAnnotationElement\r
      */\r
     public void addAnnotationElement(jalview.binding.AnnotationElement vAnnotationElement)\r
         throws java.lang.IndexOutOfBoundsException\r
     {\r
         _annotationElementList.addElement(vAnnotationElement);\r
-    } //-- void addAnnotationElement(jalview.binding.AnnotationElement) \r
+    } //-- void addAnnotationElement(jalview.binding.AnnotationElement)\r
 \r
     /**\r
      * Method addAnnotationElement\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @param vAnnotationElement\r
      */\r
@@ -100,34 +119,34 @@ public class Annotation implements java.io.Serializable {
         throws java.lang.IndexOutOfBoundsException\r
     {\r
         _annotationElementList.insertElementAt(vAnnotationElement, index);\r
-    } //-- void addAnnotationElement(int, jalview.binding.AnnotationElement) \r
+    } //-- void addAnnotationElement(int, jalview.binding.AnnotationElement)\r
 \r
     /**\r
      * Method deleteGraph\r
-     * \r
+     *\r
      */\r
     public void deleteGraph()\r
     {\r
         this._has_graph= false;\r
-    } //-- void deleteGraph() \r
+    } //-- void deleteGraph()\r
 \r
     /**\r
      * Method enumerateAnnotationElement\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return Enumeration\r
      */\r
     public java.util.Enumeration enumerateAnnotationElement()\r
     {\r
         return _annotationElementList.elements();\r
-    } //-- java.util.Enumeration enumerateAnnotationElement() \r
+    } //-- java.util.Enumeration enumerateAnnotationElement()\r
 \r
     /**\r
      * Method getAnnotationElement\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @return AnnotationElement\r
      */\r
@@ -138,15 +157,15 @@ public class Annotation implements java.io.Serializable {
         if ((index < 0) || (index > _annotationElementList.size())) {\r
             throw new IndexOutOfBoundsException();\r
         }\r
-        \r
+\r
         return (jalview.binding.AnnotationElement) _annotationElementList.elementAt(index);\r
-    } //-- jalview.binding.AnnotationElement getAnnotationElement(int) \r
+    } //-- jalview.binding.AnnotationElement getAnnotationElement(int)\r
 \r
     /**\r
      * Method getAnnotationElement\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return AnnotationElement\r
      */\r
     public jalview.binding.AnnotationElement[] getAnnotationElement()\r
@@ -157,70 +176,70 @@ public class Annotation implements java.io.Serializable {
             mArray[index] = (jalview.binding.AnnotationElement) _annotationElementList.elementAt(index);\r
         }\r
         return mArray;\r
-    } //-- jalview.binding.AnnotationElement[] getAnnotationElement() \r
+    } //-- jalview.binding.AnnotationElement[] getAnnotationElement()\r
 \r
     /**\r
      * Method getAnnotationElementCount\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return int\r
      */\r
     public int getAnnotationElementCount()\r
     {\r
         return _annotationElementList.size();\r
-    } //-- int getAnnotationElementCount() \r
+    } //-- int getAnnotationElementCount()\r
 \r
     /**\r
      * Returns the value of field 'description'.\r
-     * \r
+     *\r
      * @return String\r
      * @return the value of field 'description'.\r
      */\r
     public java.lang.String getDescription()\r
     {\r
         return this._description;\r
-    } //-- java.lang.String getDescription() \r
+    } //-- java.lang.String getDescription()\r
 \r
     /**\r
      * Returns the value of field 'graph'.\r
-     * \r
+     *\r
      * @return boolean\r
      * @return the value of field 'graph'.\r
      */\r
     public boolean getGraph()\r
     {\r
         return this._graph;\r
-    } //-- boolean getGraph() \r
+    } //-- boolean getGraph()\r
 \r
     /**\r
      * Returns the value of field 'label'.\r
-     * \r
+     *\r
      * @return String\r
      * @return the value of field 'label'.\r
      */\r
     public java.lang.String getLabel()\r
     {\r
         return this._label;\r
-    } //-- java.lang.String getLabel() \r
+    } //-- java.lang.String getLabel()\r
 \r
     /**\r
      * Method hasGraph\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return boolean\r
      */\r
     public boolean hasGraph()\r
     {\r
         return this._has_graph;\r
-    } //-- boolean hasGraph() \r
+    } //-- boolean hasGraph()\r
 \r
     /**\r
      * Method isValid\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return boolean\r
      */\r
     public boolean isValid()\r
@@ -232,50 +251,50 @@ public class Annotation implements java.io.Serializable {
             return false;\r
         }\r
         return true;\r
-    } //-- boolean isValid() \r
+    } //-- boolean isValid()\r
 \r
     /**\r
      * Method marshal\r
-     * \r
-     * \r
-     * \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
+\r
         Marshaller.marshal(this, out);\r
-    } //-- void marshal(java.io.Writer) \r
+    } //-- void marshal(java.io.Writer)\r
 \r
     /**\r
      * Method marshal\r
-     * \r
-     * \r
-     * \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
+\r
         Marshaller.marshal(this, handler);\r
-    } //-- void marshal(org.xml.sax.ContentHandler) \r
+    } //-- void marshal(org.xml.sax.ContentHandler)\r
 \r
     /**\r
      * Method removeAllAnnotationElement\r
-     * \r
+     *\r
      */\r
     public void removeAllAnnotationElement()\r
     {\r
         _annotationElementList.removeAllElements();\r
-    } //-- void removeAllAnnotationElement() \r
+    } //-- void removeAllAnnotationElement()\r
 \r
     /**\r
      * Method removeAnnotationElement\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @return AnnotationElement\r
      */\r
@@ -284,13 +303,13 @@ public class Annotation implements java.io.Serializable {
         java.lang.Object obj = _annotationElementList.elementAt(index);\r
         _annotationElementList.removeElementAt(index);\r
         return (jalview.binding.AnnotationElement) obj;\r
-    } //-- jalview.binding.AnnotationElement removeAnnotationElement(int) \r
+    } //-- jalview.binding.AnnotationElement removeAnnotationElement(int)\r
 \r
     /**\r
      * Method setAnnotationElement\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @param vAnnotationElement\r
      */\r
@@ -302,13 +321,13 @@ public class Annotation implements java.io.Serializable {
             throw new IndexOutOfBoundsException();\r
         }\r
         _annotationElementList.setElementAt(vAnnotationElement, index);\r
-    } //-- void setAnnotationElement(int, jalview.binding.AnnotationElement) \r
+    } //-- void setAnnotationElement(int, jalview.binding.AnnotationElement)\r
 \r
     /**\r
      * Method setAnnotationElement\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param annotationElementArray\r
      */\r
     public void setAnnotationElement(jalview.binding.AnnotationElement[] annotationElementArray)\r
@@ -318,44 +337,44 @@ public class Annotation implements java.io.Serializable {
         for (int i = 0; i < annotationElementArray.length; i++) {\r
             _annotationElementList.addElement(annotationElementArray[i]);\r
         }\r
-    } //-- void setAnnotationElement(jalview.binding.AnnotationElement) \r
+    } //-- void setAnnotationElement(jalview.binding.AnnotationElement)\r
 \r
     /**\r
      * Sets the value of field 'description'.\r
-     * \r
+     *\r
      * @param description the value of field 'description'.\r
      */\r
     public void setDescription(java.lang.String description)\r
     {\r
         this._description = description;\r
-    } //-- void setDescription(java.lang.String) \r
+    } //-- void setDescription(java.lang.String)\r
 \r
     /**\r
      * Sets the value of field 'graph'.\r
-     * \r
+     *\r
      * @param graph the value of field 'graph'.\r
      */\r
     public void setGraph(boolean graph)\r
     {\r
         this._graph = graph;\r
         this._has_graph = true;\r
-    } //-- void setGraph(boolean) \r
+    } //-- void setGraph(boolean)\r
 \r
     /**\r
      * Sets the value of field 'label'.\r
-     * \r
+     *\r
      * @param label the value of field 'label'.\r
      */\r
     public void setLabel(java.lang.String label)\r
     {\r
         this._label = label;\r
-    } //-- void setLabel(java.lang.String) \r
+    } //-- void setLabel(java.lang.String)\r
 \r
     /**\r
      * Method unmarshal\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param reader\r
      * @return Object\r
      */\r
@@ -363,17 +382,17 @@ public class Annotation implements java.io.Serializable {
         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
     {\r
         return (jalview.binding.Annotation) Unmarshaller.unmarshal(jalview.binding.Annotation.class, reader);\r
-    } //-- java.lang.Object unmarshal(java.io.Reader) \r
+    } //-- java.lang.Object unmarshal(java.io.Reader)\r
 \r
     /**\r
      * Method validate\r
-     * \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
+    } //-- void validate()\r
 \r
 }\r