X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fbinding%2FJalviewUserColours.java;h=8df0d448a22418171f6115b7470a7cba5e178a8f;hb=b8d09897dacc7b0ad203982b4578e2c1d8929142;hp=bbb1b97b688d401db97c9e60696a29dc54c20474;hpb=588042b69abf8e60bcc950b24c283933c7dd422f;p=jalview.git

diff --git a/src/jalview/binding/JalviewUserColours.java b/src/jalview/binding/JalviewUserColours.java
index bbb1b97..8df0d44 100755
--- a/src/jalview/binding/JalviewUserColours.java
+++ b/src/jalview/binding/JalviewUserColours.java
@@ -4,24 +4,6 @@
  * Schema.
  * $Id$
  */
-/*
-* Jalview - A Sequence Alignment Editor and Viewer
-* Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
-*
-* This program is free software; you can redistribute it and/or
-* modify it under the terms of the GNU General Public License
-* as published by the Free Software Foundation; either version 2
-* of the License, or (at your option) any later version.
-*
-* This program is distributed in the hope that it will be useful,
-* but WITHOUT ANY WARRANTY; without even the implied warranty of
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-* GNU General Public License for more details.
-*
-* You should have received a copy of the GNU General Public License
-* along with this program; if not, write to the Free Software
-* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
-*/
 package jalview.binding;
 
 import org.exolab.castor.xml.MarshalException;
@@ -48,7 +30,8 @@ import java.util.Vector;
  *
  * @version $Revision$ $Date$
  */
-public class JalviewUserColours implements java.io.Serializable {
+public class JalviewUserColours implements java.io.Serializable
+{
     //--------------------------/
     //- Class/Member Variables -/
     //--------------------------/
@@ -61,18 +44,29 @@ public class JalviewUserColours implements java.io.Serializable {
     //----------------/
     //- Constructors -/
     //----------------/
-    public JalviewUserColours() {
+    public JalviewUserColours()
+    {
         super();
         _colourList = new Vector();
     }
-     //-- jalview.binding.JalviewUserColours()
- //-----------/
 
+    //-- jalview.binding.JalviewUserColours()
+    //-----------/
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param vColour DOCUMENT ME!
+     *
+     * @throws java.lang.IndexOutOfBoundsException DOCUMENT ME!
+     */
     public void addColour(jalview.binding.Colour vColour)
-        throws java.lang.IndexOutOfBoundsException {
+        throws java.lang.IndexOutOfBoundsException
+    {
         _colourList.addElement(vColour);
     }
-     //-- void addColour(jalview.binding.Colour)
+
+    //-- void addColour(jalview.binding.Colour) 
 
     /**
      * Method addColour
@@ -83,10 +77,12 @@ public class JalviewUserColours implements java.io.Serializable {
      * @param vColour
      */
     public void addColour(int index, jalview.binding.Colour vColour)
-        throws java.lang.IndexOutOfBoundsException {
+        throws java.lang.IndexOutOfBoundsException
+    {
         _colourList.insertElementAt(vColour, index);
     }
-     //-- void addColour(int, jalview.binding.Colour)
+
+    //-- void addColour(int, jalview.binding.Colour) 
 
     /**
      * Method enumerateColour
@@ -95,10 +91,12 @@ public class JalviewUserColours implements java.io.Serializable {
      *
      * @return Enumeration
      */
-    public java.util.Enumeration enumerateColour() {
+    public java.util.Enumeration enumerateColour()
+    {
         return _colourList.elements();
     }
-     //-- java.util.Enumeration enumerateColour()
+
+    //-- java.util.Enumeration enumerateColour() 
 
     /**
      * Method getColour
@@ -109,15 +107,18 @@ public class JalviewUserColours implements java.io.Serializable {
      * @return Colour
      */
     public jalview.binding.Colour getColour(int index)
-        throws java.lang.IndexOutOfBoundsException {
+        throws java.lang.IndexOutOfBoundsException
+    {
         //-- check bounds for index
-        if ((index < 0) || (index > _colourList.size())) {
+        if ((index < 0) || (index > _colourList.size()))
+        {
             throw new IndexOutOfBoundsException();
         }
 
         return (jalview.binding.Colour) _colourList.elementAt(index);
     }
-     //-- jalview.binding.Colour getColour(int)
+
+    //-- jalview.binding.Colour getColour(int) 
 
     /**
      * Method getColour
@@ -126,17 +127,20 @@ public class JalviewUserColours implements java.io.Serializable {
      *
      * @return Colour
      */
-    public jalview.binding.Colour[] getColour() {
+    public jalview.binding.Colour[] getColour()
+    {
         int size = _colourList.size();
         jalview.binding.Colour[] mArray = new jalview.binding.Colour[size];
 
-        for (int index = 0; index < size; index++) {
+        for (int index = 0; index < size; index++)
+        {
             mArray[index] = (jalview.binding.Colour) _colourList.elementAt(index);
         }
 
         return mArray;
     }
-     //-- jalview.binding.Colour[] getColour()
+
+    //-- jalview.binding.Colour[] getColour() 
 
     /**
      * Method getColourCount
@@ -145,10 +149,12 @@ public class JalviewUserColours implements java.io.Serializable {
      *
      * @return int
      */
-    public int getColourCount() {
+    public int getColourCount()
+    {
         return _colourList.size();
     }
-     //-- int getColourCount()
+
+    //-- int getColourCount() 
 
     /**
      * Method isValid
@@ -157,16 +163,21 @@ public class JalviewUserColours implements java.io.Serializable {
      *
      * @return boolean
      */
-    public boolean isValid() {
-        try {
+    public boolean isValid()
+    {
+        try
+        {
             validate();
-        } catch (org.exolab.castor.xml.ValidationException vex) {
+        }
+        catch (org.exolab.castor.xml.ValidationException vex)
+        {
             return false;
         }
 
         return true;
     }
-     //-- boolean isValid()
+
+    //-- boolean isValid() 
 
     /**
      * Method marshal
@@ -177,10 +188,12 @@ public class JalviewUserColours implements java.io.Serializable {
      */
     public void marshal(java.io.Writer out)
         throws org.exolab.castor.xml.MarshalException, 
-            org.exolab.castor.xml.ValidationException {
+            org.exolab.castor.xml.ValidationException
+    {
         Marshaller.marshal(this, out);
     }
-     //-- void marshal(java.io.Writer)
+
+    //-- void marshal(java.io.Writer) 
 
     /**
      * Method marshal
@@ -191,19 +204,23 @@ public class JalviewUserColours implements java.io.Serializable {
      */
     public void marshal(org.xml.sax.ContentHandler handler)
         throws java.io.IOException, org.exolab.castor.xml.MarshalException, 
-            org.exolab.castor.xml.ValidationException {
+            org.exolab.castor.xml.ValidationException
+    {
         Marshaller.marshal(this, handler);
     }
-     //-- void marshal(org.xml.sax.ContentHandler)
+
+    //-- void marshal(org.xml.sax.ContentHandler) 
 
     /**
      * Method removeAllColour
      *
      */
-    public void removeAllColour() {
+    public void removeAllColour()
+    {
         _colourList.removeAllElements();
     }
-     //-- void removeAllColour()
+
+    //-- void removeAllColour() 
 
     /**
      * Method removeColour
@@ -213,13 +230,15 @@ public class JalviewUserColours implements java.io.Serializable {
      * @param index
      * @return Colour
      */
-    public jalview.binding.Colour removeColour(int index) {
+    public jalview.binding.Colour removeColour(int index)
+    {
         java.lang.Object obj = _colourList.elementAt(index);
         _colourList.removeElementAt(index);
 
         return (jalview.binding.Colour) obj;
     }
-     //-- jalview.binding.Colour removeColour(int)
+
+    //-- jalview.binding.Colour removeColour(int) 
 
     /**
      * Method setColour
@@ -230,15 +249,18 @@ public class JalviewUserColours implements java.io.Serializable {
      * @param vColour
      */
     public void setColour(int index, jalview.binding.Colour vColour)
-        throws java.lang.IndexOutOfBoundsException {
+        throws java.lang.IndexOutOfBoundsException
+    {
         //-- check bounds for index
-        if ((index < 0) || (index > _colourList.size())) {
+        if ((index < 0) || (index > _colourList.size()))
+        {
             throw new IndexOutOfBoundsException();
         }
 
         _colourList.setElementAt(vColour, index);
     }
-     //-- void setColour(int, jalview.binding.Colour)
+
+    //-- void setColour(int, jalview.binding.Colour) 
 
     /**
      * Method setColour
@@ -247,15 +269,18 @@ public class JalviewUserColours implements java.io.Serializable {
      *
      * @param colourArray
      */
-    public void setColour(jalview.binding.Colour[] colourArray) {
+    public void setColour(jalview.binding.Colour[] colourArray)
+    {
         //-- copy array
         _colourList.removeAllElements();
 
-        for (int i = 0; i < colourArray.length; i++) {
+        for (int i = 0; i < colourArray.length; i++)
+        {
             _colourList.addElement(colourArray[i]);
         }
     }
-     //-- void setColour(jalview.binding.Colour)
+
+    //-- void setColour(jalview.binding.Colour) 
 
     /**
      * Method unmarshal
@@ -267,19 +292,23 @@ public class JalviewUserColours implements java.io.Serializable {
      */
     public static java.lang.Object unmarshal(java.io.Reader reader)
         throws org.exolab.castor.xml.MarshalException, 
-            org.exolab.castor.xml.ValidationException {
+            org.exolab.castor.xml.ValidationException
+    {
         return (jalview.binding.JalviewUserColours) Unmarshaller.unmarshal(jalview.binding.JalviewUserColours.class,
             reader);
     }
-     //-- java.lang.Object unmarshal(java.io.Reader)
+
+    //-- java.lang.Object unmarshal(java.io.Reader) 
 
     /**
      * Method validate
      *
      */
-    public void validate() throws org.exolab.castor.xml.ValidationException {
+    public void validate() throws org.exolab.castor.xml.ValidationException
+    {
         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
         validator.validate(this);
     }
-     //-- void validate()
+
+    //-- void validate() 
 }