X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fbinding%2FJalviewUserColours.java;h=676a62358dc47c9b53aa43d389f357713f9fa214;hb=c68ce4c63bd79f23b87aac3eb0afa7f6b42a3098;hp=bbb1b97b688d401db97c9e60696a29dc54c20474;hpb=5ba8b4a50183f8a799069ba7a4dabd4cc2589a5b;p=jalview.git diff --git a/src/jalview/binding/JalviewUserColours.java b/src/jalview/binding/JalviewUserColours.java index bbb1b97..676a623 100755 --- a/src/jalview/binding/JalviewUserColours.java +++ b/src/jalview/binding/JalviewUserColours.java @@ -1,56 +1,38 @@ /* - * This class was automatically generated with + * This class was automatically generated with * Castor 0.9.6, using an XML * 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; -import org.exolab.castor.xml.Marshaller; -import org.exolab.castor.xml.Unmarshaller; -import org.exolab.castor.xml.ValidationException; -import org.xml.sax.ContentHandler; +package jalview.binding; + //---------------------------------/ + //- Imported classes and packages -/ //---------------------------------/ -//- Imported classes and packages -/ -//---------------------------------/ + import java.io.IOException; import java.io.Reader; import java.io.Serializable; import java.io.Writer; - import java.util.Enumeration; import java.util.Vector; - +import org.exolab.castor.xml.MarshalException; +import org.exolab.castor.xml.Marshaller; +import org.exolab.castor.xml.Unmarshaller; +import org.exolab.castor.xml.ValidationException; +import org.xml.sax.ContentHandler; /** * Class JalviewUserColours. - * + * * @version $Revision$ $Date$ */ public class JalviewUserColours implements java.io.Serializable { - //--------------------------/ - //- Class/Member Variables -/ + + + //--------------------------/ + //- Class/Member Variables -/ //--------------------------/ /** @@ -58,228 +40,235 @@ public class JalviewUserColours implements java.io.Serializable { */ private java.util.Vector _colourList; + + //----------------/ + //- Constructors -/ //----------------/ - //- Constructors -/ - //----------------/ + public JalviewUserColours() { super(); _colourList = new Vector(); - } - //-- jalview.binding.JalviewUserColours() - //-----------/ + } //-- jalview.binding.JalviewUserColours() + + //-----------/ + //- Methods -/ + //-----------/ + + /** + * Method addColour + * + * + * + * @param vColour + */ 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 - * - * - * + * + * + * * @param index * @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 - * - * - * + * + * + * * @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 - * - * - * + * + * + * * @param index * @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())) { throw new IndexOutOfBoundsException(); } - + return (jalview.binding.Colour) _colourList.elementAt(index); - } - //-- jalview.binding.Colour getColour(int) + } //-- jalview.binding.Colour getColour(int) /** * Method getColour - * - * - * + * + * + * * @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++) { mArray[index] = (jalview.binding.Colour) _colourList.elementAt(index); } - return mArray; - } - //-- jalview.binding.Colour[] getColour() + } //-- jalview.binding.Colour[] getColour() /** * Method getColourCount - * - * - * + * + * + * * @return int */ - public int getColourCount() { + public int getColourCount() + { return _colourList.size(); - } - //-- int getColourCount() + } //-- int getColourCount() /** * Method isValid - * - * - * + * + * + * * @return boolean */ - public boolean isValid() { + 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 - * - * - * + * + * + * * @param out */ public void marshal(java.io.Writer out) - throws org.exolab.castor.xml.MarshalException, - org.exolab.castor.xml.ValidationException { + throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException + { + Marshaller.marshal(this, out); - } - //-- void marshal(java.io.Writer) + } //-- void marshal(java.io.Writer) /** * Method marshal - * - * - * + * + * + * * @param handler */ public void marshal(org.xml.sax.ContentHandler handler) - throws java.io.IOException, org.exolab.castor.xml.MarshalException, - org.exolab.castor.xml.ValidationException { + throws java.io.IOException, org.exolab.castor.xml.MarshalException, 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 - * - * - * + * + * + * * @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 - * - * - * + * + * + * * @param index * @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())) { throw new IndexOutOfBoundsException(); } - _colourList.setElementAt(vColour, index); - } - //-- void setColour(int, jalview.binding.Colour) + } //-- void setColour(int, jalview.binding.Colour) /** * Method setColour - * - * - * + * + * + * * @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++) { _colourList.addElement(colourArray[i]); } - } - //-- void setColour(jalview.binding.Colour) + } //-- void setColour(jalview.binding.Colour) /** * Method unmarshal - * - * - * + * + * + * * @param reader * @return Object */ public static java.lang.Object unmarshal(java.io.Reader reader) - throws org.exolab.castor.xml.MarshalException, - org.exolab.castor.xml.ValidationException { - return (jalview.binding.JalviewUserColours) Unmarshaller.unmarshal(jalview.binding.JalviewUserColours.class, - reader); - } - //-- java.lang.Object unmarshal(java.io.Reader) + throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException + { + return (jalview.binding.JalviewUserColours) Unmarshaller.unmarshal(jalview.binding.JalviewUserColours.class, 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() + }