Formatted source
[jalview.git] / src / jalview / binding / JalviewUserColours.java
index 354dc2f..bbb1b97 100755 (executable)
@@ -4,7 +4,6 @@
  * 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
 * 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
- //- 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
@@ -48,10 +49,8 @@ import org.xml.sax.ContentHandler;
  * @version $Revision$ $Date$\r
  */\r
 public class JalviewUserColours implements java.io.Serializable {\r
-\r
-\r
-      //--------------------------/\r
-     //- Class/Member Variables -/\r
+    //--------------------------/\r
+    //- Class/Member Variables -/\r
     //--------------------------/\r
 \r
     /**\r
@@ -59,33 +58,21 @@ public class JalviewUserColours implements java.io.Serializable {
      */\r
     private java.util.Vector _colourList;\r
 \r
-\r
-      //----------------/\r
-     //- Constructors -/\r
     //----------------/\r
-\r
+    //- Constructors -/\r
+    //----------------/\r
     public JalviewUserColours() {\r
         super();\r
         _colourList = new Vector();\r
-    } //-- jalview.binding.JalviewUserColours()\r
-\r
+    }\r
+     //-- jalview.binding.JalviewUserColours()\r
+ //-----------/\r
 \r
-      //-----------/\r
-     //- Methods -/\r
-    //-----------/\r
-\r
-    /**\r
-     * Method addColour\r
-     *\r
-     *\r
-     *\r
-     * @param vColour\r
-     */\r
     public void addColour(jalview.binding.Colour vColour)\r
-        throws java.lang.IndexOutOfBoundsException\r
-    {\r
+        throws java.lang.IndexOutOfBoundsException {\r
         _colourList.addElement(vColour);\r
-    } //-- void addColour(jalview.binding.Colour)\r
+    }\r
+     //-- void addColour(jalview.binding.Colour)\r
 \r
     /**\r
      * Method addColour\r
@@ -96,10 +83,10 @@ public class JalviewUserColours implements java.io.Serializable {
      * @param vColour\r
      */\r
     public void addColour(int index, jalview.binding.Colour vColour)\r
-        throws java.lang.IndexOutOfBoundsException\r
-    {\r
+        throws java.lang.IndexOutOfBoundsException {\r
         _colourList.insertElementAt(vColour, index);\r
-    } //-- void addColour(int, jalview.binding.Colour)\r
+    }\r
+     //-- void addColour(int, jalview.binding.Colour)\r
 \r
     /**\r
      * Method enumerateColour\r
@@ -108,10 +95,10 @@ public class JalviewUserColours implements java.io.Serializable {
      *\r
      * @return Enumeration\r
      */\r
-    public java.util.Enumeration enumerateColour()\r
-    {\r
+    public java.util.Enumeration enumerateColour() {\r
         return _colourList.elements();\r
-    } //-- java.util.Enumeration enumerateColour()\r
+    }\r
+     //-- java.util.Enumeration enumerateColour()\r
 \r
     /**\r
      * Method getColour\r
@@ -122,15 +109,15 @@ public class JalviewUserColours implements java.io.Serializable {
      * @return Colour\r
      */\r
     public jalview.binding.Colour getColour(int index)\r
-        throws java.lang.IndexOutOfBoundsException\r
-    {\r
+        throws java.lang.IndexOutOfBoundsException {\r
         //-- check bounds for index\r
         if ((index < 0) || (index > _colourList.size())) {\r
             throw new IndexOutOfBoundsException();\r
         }\r
 \r
         return (jalview.binding.Colour) _colourList.elementAt(index);\r
-    } //-- jalview.binding.Colour getColour(int)\r
+    }\r
+     //-- jalview.binding.Colour getColour(int)\r
 \r
     /**\r
      * Method getColour\r
@@ -139,15 +126,17 @@ public class JalviewUserColours implements java.io.Serializable {
      *\r
      * @return Colour\r
      */\r
-    public jalview.binding.Colour[] getColour()\r
-    {\r
+    public jalview.binding.Colour[] getColour() {\r
         int size = _colourList.size();\r
         jalview.binding.Colour[] mArray = new jalview.binding.Colour[size];\r
+\r
         for (int index = 0; index < size; index++) {\r
             mArray[index] = (jalview.binding.Colour) _colourList.elementAt(index);\r
         }\r
+\r
         return mArray;\r
-    } //-- jalview.binding.Colour[] getColour()\r
+    }\r
+     //-- jalview.binding.Colour[] getColour()\r
 \r
     /**\r
      * Method getColourCount\r
@@ -156,10 +145,10 @@ public class JalviewUserColours implements java.io.Serializable {
      *\r
      * @return int\r
      */\r
-    public int getColourCount()\r
-    {\r
+    public int getColourCount() {\r
         return _colourList.size();\r
-    } //-- int getColourCount()\r
+    }\r
+     //-- int getColourCount()\r
 \r
     /**\r
      * Method isValid\r
@@ -168,16 +157,16 @@ public class JalviewUserColours implements java.io.Serializable {
      *\r
      * @return boolean\r
      */\r
-    public boolean isValid()\r
-    {\r
+    public boolean isValid() {\r
         try {\r
             validate();\r
-        }\r
-        catch (org.exolab.castor.xml.ValidationException vex) {\r
+        } catch (org.exolab.castor.xml.ValidationException vex) {\r
             return false;\r
         }\r
+\r
         return true;\r
-    } //-- boolean isValid()\r
+    }\r
+     //-- boolean isValid()\r
 \r
     /**\r
      * Method marshal\r
@@ -187,11 +176,11 @@ 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
-    {\r
-\r
+        throws org.exolab.castor.xml.MarshalException, \r
+            org.exolab.castor.xml.ValidationException {\r
         Marshaller.marshal(this, out);\r
-    } //-- void marshal(java.io.Writer)\r
+    }\r
+     //-- void marshal(java.io.Writer)\r
 \r
     /**\r
      * Method marshal\r
@@ -201,20 +190,20 @@ 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
-    {\r
-\r
+        throws java.io.IOException, org.exolab.castor.xml.MarshalException, \r
+            org.exolab.castor.xml.ValidationException {\r
         Marshaller.marshal(this, handler);\r
-    } //-- void marshal(org.xml.sax.ContentHandler)\r
+    }\r
+     //-- void marshal(org.xml.sax.ContentHandler)\r
 \r
     /**\r
      * Method removeAllColour\r
      *\r
      */\r
-    public void removeAllColour()\r
-    {\r
+    public void removeAllColour() {\r
         _colourList.removeAllElements();\r
-    } //-- void removeAllColour()\r
+    }\r
+     //-- void removeAllColour()\r
 \r
     /**\r
      * Method removeColour\r
@@ -224,12 +213,13 @@ public class JalviewUserColours implements java.io.Serializable {
      * @param index\r
      * @return Colour\r
      */\r
-    public jalview.binding.Colour removeColour(int index)\r
-    {\r
+    public jalview.binding.Colour removeColour(int index) {\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
+     //-- jalview.binding.Colour removeColour(int)\r
 \r
     /**\r
      * Method setColour\r
@@ -240,14 +230,15 @@ public class JalviewUserColours implements java.io.Serializable {
      * @param vColour\r
      */\r
     public void setColour(int index, jalview.binding.Colour vColour)\r
-        throws java.lang.IndexOutOfBoundsException\r
-    {\r
+        throws java.lang.IndexOutOfBoundsException {\r
         //-- check bounds for index\r
         if ((index < 0) || (index > _colourList.size())) {\r
             throw new IndexOutOfBoundsException();\r
         }\r
+\r
         _colourList.setElementAt(vColour, index);\r
-    } //-- void setColour(int, jalview.binding.Colour)\r
+    }\r
+     //-- void setColour(int, jalview.binding.Colour)\r
 \r
     /**\r
      * Method setColour\r
@@ -256,14 +247,15 @@ public class JalviewUserColours implements java.io.Serializable {
      *\r
      * @param colourArray\r
      */\r
-    public void setColour(jalview.binding.Colour[] colourArray)\r
-    {\r
+    public void setColour(jalview.binding.Colour[] colourArray) {\r
         //-- copy array\r
         _colourList.removeAllElements();\r
+\r
         for (int i = 0; i < colourArray.length; i++) {\r
             _colourList.addElement(colourArray[i]);\r
         }\r
-    } //-- void setColour(jalview.binding.Colour)\r
+    }\r
+     //-- void setColour(jalview.binding.Colour)\r
 \r
     /**\r
      * Method unmarshal\r
@@ -274,20 +266,20 @@ 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
-    {\r
-        return (jalview.binding.JalviewUserColours) Unmarshaller.unmarshal(jalview.binding.JalviewUserColours.class, reader);\r
-    } //-- java.lang.Object unmarshal(java.io.Reader)\r
+        throws org.exolab.castor.xml.MarshalException, \r
+            org.exolab.castor.xml.ValidationException {\r
+        return (jalview.binding.JalviewUserColours) Unmarshaller.unmarshal(jalview.binding.JalviewUserColours.class,\r
+            reader);\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
-    {\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
-    } //-- void validate()\r
-\r
+    }\r
+     //-- void validate()\r
 }\r