Formatting changes
[jalview.git] / src / jalview / binding / JalviewUserColours.java
index 676a623..8df0d44 100755 (executable)
@@ -1,38 +1,39 @@
 /*\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
 package jalview.binding;\r
 \r
-  //---------------------------------/\r
- //- Imported classes and packages -/\r
-//---------------------------------/\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
 \r
+import org.xml.sax.ContentHandler;\r
+\r
+//---------------------------------/\r
+//- Imported classes and packages -/\r
+//---------------------------------/\r
 import java.io.IOException;\r
 import java.io.Reader;\r
 import java.io.Serializable;\r
 import java.io.Writer;\r
+\r
 import java.util.Enumeration;\r
 import java.util.Vector;\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
 /**\r
  * Class JalviewUserColours.\r
- * \r
+ *\r
  * @version $Revision$ $Date$\r
  */\r
-public class JalviewUserColours implements java.io.Serializable {\r
-\r
-\r
-      //--------------------------/\r
-     //- Class/Member Variables -/\r
+public class JalviewUserColours implements java.io.Serializable\r
+{\r
+    //--------------------------/\r
+    //- Class/Member Variables -/\r
     //--------------------------/\r
 \r
     /**\r
@@ -40,39 +41,38 @@ public class JalviewUserColours implements java.io.Serializable {
      */\r
     private java.util.Vector _colourList;\r
 \r
-\r
-      //----------------/\r
-     //- Constructors -/\r
     //----------------/\r
-\r
-    public JalviewUserColours() {\r
+    //- Constructors -/\r
+    //----------------/\r
+    public JalviewUserColours()\r
+    {\r
         super();\r
         _colourList = new Vector();\r
-    } //-- jalview.binding.JalviewUserColours()\r
+    }\r
 \r
-\r
-      //-----------/\r
-     //- Methods -/\r
+    //-- jalview.binding.JalviewUserColours()\r
     //-----------/\r
 \r
     /**\r
-     * Method addColour\r
-     * \r
-     * \r
-     * \r
-     * @param vColour\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param vColour DOCUMENT ME!\r
+     *\r
+     * @throws java.lang.IndexOutOfBoundsException DOCUMENT ME!\r
      */\r
     public void addColour(jalview.binding.Colour vColour)\r
         throws java.lang.IndexOutOfBoundsException\r
     {\r
         _colourList.addElement(vColour);\r
-    } //-- void addColour(jalview.binding.Colour) \r
+    }\r
+\r
+    //-- void addColour(jalview.binding.Colour) \r
 \r
     /**\r
      * Method addColour\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @param vColour\r
      */\r
@@ -80,25 +80,29 @@ public class JalviewUserColours implements java.io.Serializable {
         throws java.lang.IndexOutOfBoundsException\r
     {\r
         _colourList.insertElementAt(vColour, index);\r
-    } //-- void addColour(int, jalview.binding.Colour) \r
+    }\r
+\r
+    //-- void addColour(int, jalview.binding.Colour) \r
 \r
     /**\r
      * Method enumerateColour\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return Enumeration\r
      */\r
     public java.util.Enumeration enumerateColour()\r
     {\r
         return _colourList.elements();\r
-    } //-- java.util.Enumeration enumerateColour() \r
+    }\r
+\r
+    //-- java.util.Enumeration enumerateColour() \r
 \r
     /**\r
      * Method getColour\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @return Colour\r
      */\r
@@ -106,102 +110,123 @@ public class JalviewUserColours implements java.io.Serializable {
         throws java.lang.IndexOutOfBoundsException\r
     {\r
         //-- check bounds for index\r
-        if ((index < 0) || (index > _colourList.size())) {\r
+        if ((index < 0) || (index > _colourList.size()))\r
+        {\r
             throw new IndexOutOfBoundsException();\r
         }\r
-        \r
+\r
         return (jalview.binding.Colour) _colourList.elementAt(index);\r
-    } //-- jalview.binding.Colour getColour(int) \r
+    }\r
+\r
+    //-- jalview.binding.Colour getColour(int) \r
 \r
     /**\r
      * Method getColour\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return Colour\r
      */\r
     public jalview.binding.Colour[] getColour()\r
     {\r
         int size = _colourList.size();\r
         jalview.binding.Colour[] mArray = new jalview.binding.Colour[size];\r
-        for (int index = 0; index < size; index++) {\r
+\r
+        for (int index = 0; index < size; index++)\r
+        {\r
             mArray[index] = (jalview.binding.Colour) _colourList.elementAt(index);\r
         }\r
+\r
         return mArray;\r
-    } //-- jalview.binding.Colour[] getColour() \r
+    }\r
+\r
+    //-- jalview.binding.Colour[] getColour() \r
 \r
     /**\r
      * Method getColourCount\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return int\r
      */\r
     public int getColourCount()\r
     {\r
         return _colourList.size();\r
-    } //-- int getColourCount() \r
+    }\r
+\r
+    //-- int getColourCount() \r
 \r
     /**\r
      * Method isValid\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @return boolean\r
      */\r
     public boolean isValid()\r
     {\r
-        try {\r
+        try\r
+        {\r
             validate();\r
         }\r
-        catch (org.exolab.castor.xml.ValidationException vex) {\r
+        catch (org.exolab.castor.xml.ValidationException vex)\r
+        {\r
             return false;\r
         }\r
+\r
         return true;\r
-    } //-- boolean isValid() \r
+    }\r
+\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
+        throws org.exolab.castor.xml.MarshalException, \r
+            org.exolab.castor.xml.ValidationException\r
     {\r
-        \r
         Marshaller.marshal(this, out);\r
-    } //-- void marshal(java.io.Writer) \r
+    }\r
+\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
+        throws java.io.IOException, org.exolab.castor.xml.MarshalException, \r
+            org.exolab.castor.xml.ValidationException\r
     {\r
-        \r
         Marshaller.marshal(this, handler);\r
-    } //-- void marshal(org.xml.sax.ContentHandler) \r
+    }\r
+\r
+    //-- void marshal(org.xml.sax.ContentHandler) \r
 \r
     /**\r
      * Method removeAllColour\r
-     * \r
+     *\r
      */\r
     public void removeAllColour()\r
     {\r
         _colourList.removeAllElements();\r
-    } //-- void removeAllColour() \r
+    }\r
+\r
+    //-- void removeAllColour() \r
 \r
     /**\r
      * Method removeColour\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @return Colour\r
      */\r
@@ -209,14 +234,17 @@ public class JalviewUserColours implements java.io.Serializable {
     {\r
         java.lang.Object obj = _colourList.elementAt(index);\r
         _colourList.removeElementAt(index);\r
+\r
         return (jalview.binding.Colour) obj;\r
-    } //-- jalview.binding.Colour removeColour(int) \r
+    }\r
+\r
+    //-- jalview.binding.Colour removeColour(int) \r
 \r
     /**\r
      * Method setColour\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param index\r
      * @param vColour\r
      */\r
@@ -224,51 +252,63 @@ public class JalviewUserColours implements java.io.Serializable {
         throws java.lang.IndexOutOfBoundsException\r
     {\r
         //-- check bounds for index\r
-        if ((index < 0) || (index > _colourList.size())) {\r
+        if ((index < 0) || (index > _colourList.size()))\r
+        {\r
             throw new IndexOutOfBoundsException();\r
         }\r
+\r
         _colourList.setElementAt(vColour, index);\r
-    } //-- void setColour(int, jalview.binding.Colour) \r
+    }\r
+\r
+    //-- void setColour(int, jalview.binding.Colour) \r
 \r
     /**\r
      * Method setColour\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param colourArray\r
      */\r
     public void setColour(jalview.binding.Colour[] colourArray)\r
     {\r
         //-- copy array\r
         _colourList.removeAllElements();\r
-        for (int i = 0; i < colourArray.length; i++) {\r
+\r
+        for (int i = 0; i < colourArray.length; i++)\r
+        {\r
             _colourList.addElement(colourArray[i]);\r
         }\r
-    } //-- void setColour(jalview.binding.Colour) \r
+    }\r
+\r
+    //-- void setColour(jalview.binding.Colour) \r
 \r
     /**\r
      * Method unmarshal\r
-     * \r
-     * \r
-     * \r
+     *\r
+     *\r
+     *\r
      * @param reader\r
      * @return Object\r
      */\r
     public static java.lang.Object unmarshal(java.io.Reader reader)\r
-        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
+        throws org.exolab.castor.xml.MarshalException, \r
+            org.exolab.castor.xml.ValidationException\r
     {\r
-        return (jalview.binding.JalviewUserColours) Unmarshaller.unmarshal(jalview.binding.JalviewUserColours.class, reader);\r
-    } //-- java.lang.Object unmarshal(java.io.Reader) \r
+        return (jalview.binding.JalviewUserColours) Unmarshaller.unmarshal(jalview.binding.JalviewUserColours.class,\r
+            reader);\r
+    }\r
+\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
+    public void validate() 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
+    }\r
 \r
+    //-- void validate() \r
 }\r