Formatting changes
[jalview.git] / src / jalview / binding / JalviewUserColours.java
index 354dc2f..8df0d44 100755 (executable)
@@ -4,54 +4,36 @@
  * Schema.\r
  * $Id$\r
  */\r
+package jalview.binding;\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
+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
-package jalview.binding;\r
+import org.xml.sax.ContentHandler;\r
 \r
-  //---------------------------------/\r
- //- Imported classes and packages -/\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
  * @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
@@ -59,33 +41,32 @@ 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
+     * DOCUMENT ME!\r
      *\r
+     * @param vColour DOCUMENT ME!\r
      *\r
-     * @param vColour\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
@@ -99,7 +80,9 @@ 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
@@ -111,7 +94,9 @@ public class JalviewUserColours implements java.io.Serializable {
     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
@@ -125,12 +110,15 @@ 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
         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
@@ -143,11 +131,16 @@ public class JalviewUserColours implements java.io.Serializable {
     {\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
@@ -159,7 +152,9 @@ public class JalviewUserColours implements java.io.Serializable {
     public int getColourCount()\r
     {\r
         return _colourList.size();\r
-    } //-- int getColourCount()\r
+    }\r
+\r
+    //-- int getColourCount() \r
 \r
     /**\r
      * Method isValid\r
@@ -170,14 +165,19 @@ public class JalviewUserColours implements java.io.Serializable {
      */\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
@@ -187,11 +187,13 @@ public class JalviewUserColours implements java.io.Serializable {
      * @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
@@ -201,11 +203,13 @@ public class JalviewUserColours implements java.io.Serializable {
      * @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
@@ -214,7 +218,9 @@ public class JalviewUserColours implements java.io.Serializable {
     public void removeAllColour()\r
     {\r
         _colourList.removeAllElements();\r
-    } //-- void removeAllColour()\r
+    }\r
+\r
+    //-- void removeAllColour() \r
 \r
     /**\r
      * Method removeColour\r
@@ -228,8 +234,11 @@ 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
@@ -243,11 +252,15 @@ 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
@@ -260,10 +273,14 @@ public class JalviewUserColours implements java.io.Serializable {
     {\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
@@ -274,20 +291,24 @@ public class JalviewUserColours implements java.io.Serializable {
      * @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
-    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