X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fschemabinding%2Fversion2%2FJalviewUserColours.java;h=abeff9e41e1f7e6bcbc1ad4be53ed96f1c011cd9;hb=865a855a4ca87eadb3e5ff284ed32ed307d9c34b;hp=7963596c9d73f598a4db0281dea4f603ee708c15;hpb=48df59aa393e03aa7269b2df662ac1b8d58cbb25;p=jalview.git diff --git a/src/jalview/schemabinding/version2/JalviewUserColours.java b/src/jalview/schemabinding/version2/JalviewUserColours.java old mode 100755 new mode 100644 index 7963596..abeff9e --- a/src/jalview/schemabinding/version2/JalviewUserColours.java +++ b/src/jalview/schemabinding/version2/JalviewUserColours.java @@ -1,300 +1,357 @@ -/* - * This class was automatically generated with - * Castor 0.9.6, using an XML - * Schema. - * $Id$ - */ - -package jalview.schemabinding.version2; - - //---------------------------------/ - //- 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 -/ - //--------------------------/ - - /** - * Field _schemeName - */ - private java.lang.String _schemeName; - - /** - * Field _colourList - */ - private java.util.Vector _colourList; - - - //----------------/ - //- Constructors -/ - //----------------/ - - public JalviewUserColours() { - super(); - _colourList = new Vector(); - } //-- jalview.schemabinding.version2.JalviewUserColours() - - - //-----------/ - //- Methods -/ - //-----------/ - - /** - * Method addColour - * - * - * - * @param vColour - */ - public void addColour(jalview.schemabinding.version2.Colour vColour) - throws java.lang.IndexOutOfBoundsException - { - _colourList.addElement(vColour); - } //-- void addColour(jalview.schemabinding.version2.Colour) - - /** - * Method addColour - * - * - * - * @param index - * @param vColour - */ - public void addColour(int index, jalview.schemabinding.version2.Colour vColour) - throws java.lang.IndexOutOfBoundsException - { - _colourList.insertElementAt(vColour, index); - } //-- void addColour(int, jalview.schemabinding.version2.Colour) - - /** - * Method enumerateColour - * - * - * - * @return Enumeration - */ - public java.util.Enumeration enumerateColour() - { - return _colourList.elements(); - } //-- java.util.Enumeration enumerateColour() - - /** - * Method getColour - * - * - * - * @param index - * @return Colour - */ - public jalview.schemabinding.version2.Colour getColour(int index) - throws java.lang.IndexOutOfBoundsException - { - //-- check bounds for index - if ((index < 0) || (index > _colourList.size())) { - throw new IndexOutOfBoundsException(); - } - - return (jalview.schemabinding.version2.Colour) _colourList.elementAt(index); - } //-- jalview.schemabinding.version2.Colour getColour(int) - - /** - * Method getColour - * - * - * - * @return Colour - */ - public jalview.schemabinding.version2.Colour[] getColour() - { - int size = _colourList.size(); - jalview.schemabinding.version2.Colour[] mArray = new jalview.schemabinding.version2.Colour[size]; - for (int index = 0; index < size; index++) { - mArray[index] = (jalview.schemabinding.version2.Colour) _colourList.elementAt(index); - } - return mArray; - } //-- jalview.schemabinding.version2.Colour[] getColour() - - /** - * Method getColourCount - * - * - * - * @return int - */ - public int getColourCount() - { - return _colourList.size(); - } //-- int getColourCount() - - /** - * Returns the value of field 'schemeName'. - * - * @return String - * @return the value of field 'schemeName'. - */ - public java.lang.String getSchemeName() - { - return this._schemeName; - } //-- java.lang.String getSchemeName() - - /** - * Method isValid - * - * - * - * @return boolean - */ - public boolean isValid() - { - try { - validate(); - } - catch (org.exolab.castor.xml.ValidationException vex) { - return false; - } - return true; - } //-- boolean isValid() - - /** - * Method marshal - * - * - * - * @param out - */ - public void marshal(java.io.Writer out) - throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException - { - - Marshaller.marshal(this, out); - } //-- 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 - { - - Marshaller.marshal(this, handler); - } //-- void marshal(org.xml.sax.ContentHandler) - - /** - * Method removeAllColour - * - */ - public void removeAllColour() - { - _colourList.removeAllElements(); - } //-- void removeAllColour() - - /** - * Method removeColour - * - * - * - * @param index - * @return Colour - */ - public jalview.schemabinding.version2.Colour removeColour(int index) - { - java.lang.Object obj = _colourList.elementAt(index); - _colourList.removeElementAt(index); - return (jalview.schemabinding.version2.Colour) obj; - } //-- jalview.schemabinding.version2.Colour removeColour(int) - - /** - * Method setColour - * - * - * - * @param index - * @param vColour - */ - public void setColour(int index, jalview.schemabinding.version2.Colour vColour) - 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.schemabinding.version2.Colour) - - /** - * Method setColour - * - * - * - * @param colourArray - */ - public void setColour(jalview.schemabinding.version2.Colour[] colourArray) - { - //-- copy array - _colourList.removeAllElements(); - for (int i = 0; i < colourArray.length; i++) { - _colourList.addElement(colourArray[i]); - } - } //-- void setColour(jalview.schemabinding.version2.Colour) - - /** - * Sets the value of field 'schemeName'. - * - * @param schemeName the value of field 'schemeName'. - */ - public void setSchemeName(java.lang.String schemeName) - { - this._schemeName = schemeName; - } //-- void setSchemeName(java.lang.String) - - /** - * 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.schemabinding.version2.JalviewUserColours) Unmarshaller.unmarshal(jalview.schemabinding.version2.JalviewUserColours.class, reader); - } //-- java.lang.Object unmarshal(java.io.Reader) - - /** - * Method validate - * - */ - 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() - -} +/* + * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1) + * Copyright (C) 2014 The Jalview Authors + * + * This file is part of Jalview. + * + * Jalview 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 3 of the License, or (at your option) any later version. + * + * Jalview 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 Jalview. If not, see . + * The Jalview Authors are detailed in the 'AUTHORS' file. + */ +package jalview.schemabinding.version2; + +//---------------------------------/ +//- Imported classes and packages -/ +//---------------------------------/ + +import org.exolab.castor.xml.Marshaller; +import org.exolab.castor.xml.Unmarshaller; + +/** + * Class JalviewUserColours. + * + * @version $Revision$ $Date$ + */ +public class JalviewUserColours implements java.io.Serializable +{ + + // --------------------------/ + // - Class/Member Variables -/ + // --------------------------/ + + /** + * Field _schemeName. + */ + private java.lang.String _schemeName; + + /** + * Jalview colour scheme document version. + * + */ + private java.lang.String _version; + + /** + * Field _colourList. + */ + private java.util.Vector _colourList; + + // ----------------/ + // - Constructors -/ + // ----------------/ + + public JalviewUserColours() + { + super(); + this._colourList = new java.util.Vector(); + } + + // -----------/ + // - Methods -/ + // -----------/ + + /** + * + * + * @param vColour + * @throws java.lang.IndexOutOfBoundsException + * if the index given is outside the bounds of the collection + */ + public void addColour(final Colour vColour) + throws java.lang.IndexOutOfBoundsException + { + this._colourList.addElement(vColour); + } + + /** + * + * + * @param index + * @param vColour + * @throws java.lang.IndexOutOfBoundsException + * if the index given is outside the bounds of the collection + */ + public void addColour(final int index, final Colour vColour) + throws java.lang.IndexOutOfBoundsException + { + this._colourList.add(index, vColour); + } + + /** + * Method enumerateColour. + * + * @return an Enumeration over all Colour elements + */ + public java.util.Enumeration enumerateColour() + { + return this._colourList.elements(); + } + + /** + * Method getColour. + * + * @param index + * @throws java.lang.IndexOutOfBoundsException + * if the index given is outside the bounds of the collection + * @return the value of the Colour at the given index + */ + public Colour getColour(final int index) + throws java.lang.IndexOutOfBoundsException + { + // check bounds for index + if (index < 0 || index >= this._colourList.size()) + { + throw new IndexOutOfBoundsException("getColour: Index value '" + + index + "' not in range [0.." + + (this._colourList.size() - 1) + "]"); + } + + return (Colour) _colourList.get(index); + } + + /** + * Method getColour.Returns the contents of the collection in an Array. + *

+ * Note: Just in case the collection contents are changing in another thread, + * we pass a 0-length Array of the correct type into the API call. This way we + * know that the Array returned is of exactly the correct length. + * + * @return this collection as an Array + */ + public Colour[] getColour() + { + Colour[] array = new Colour[0]; + return (Colour[]) this._colourList.toArray(array); + } + + /** + * Method getColourCount. + * + * @return the size of this collection + */ + public int getColourCount() + { + return this._colourList.size(); + } + + /** + * Returns the value of field 'schemeName'. + * + * @return the value of field 'SchemeName'. + */ + public java.lang.String getSchemeName() + { + return this._schemeName; + } + + /** + * Returns the value of field 'version'. The field 'version' has the following + * description: Jalview colour scheme document version. + * + * + * @return the value of field 'Version'. + */ + public java.lang.String getVersion() + { + return this._version; + } + + /** + * Method isValid. + * + * @return true if this object is valid according to the schema + */ + public boolean isValid() + { + try + { + validate(); + } catch (org.exolab.castor.xml.ValidationException vex) + { + return false; + } + return true; + } + + /** + * + * + * @param out + * @throws org.exolab.castor.xml.MarshalException + * if object is null or if any SAXException is thrown during + * marshaling + * @throws org.exolab.castor.xml.ValidationException + * if this object is an invalid instance according to the schema + */ + public void marshal(final java.io.Writer out) + throws org.exolab.castor.xml.MarshalException, + org.exolab.castor.xml.ValidationException + { + Marshaller.marshal(this, out); + } + + /** + * + * + * @param handler + * @throws java.io.IOException + * if an IOException occurs during marshaling + * @throws org.exolab.castor.xml.ValidationException + * if this object is an invalid instance according to the schema + * @throws org.exolab.castor.xml.MarshalException + * if object is null or if any SAXException is thrown during + * marshaling + */ + public void marshal(final org.xml.sax.ContentHandler handler) + throws java.io.IOException, + org.exolab.castor.xml.MarshalException, + org.exolab.castor.xml.ValidationException + { + Marshaller.marshal(this, handler); + } + + /** + */ + public void removeAllColour() + { + this._colourList.clear(); + } + + /** + * Method removeColour. + * + * @param vColour + * @return true if the object was removed from the collection. + */ + public boolean removeColour(final Colour vColour) + { + boolean removed = _colourList.remove(vColour); + return removed; + } + + /** + * Method removeColourAt. + * + * @param index + * @return the element removed from the collection + */ + public Colour removeColourAt(final int index) + { + java.lang.Object obj = this._colourList.remove(index); + return (Colour) obj; + } + + /** + * + * + * @param index + * @param vColour + * @throws java.lang.IndexOutOfBoundsException + * if the index given is outside the bounds of the collection + */ + public void setColour(final int index, final Colour vColour) + throws java.lang.IndexOutOfBoundsException + { + // check bounds for index + if (index < 0 || index >= this._colourList.size()) + { + throw new IndexOutOfBoundsException("setColour: Index value '" + + index + "' not in range [0.." + + (this._colourList.size() - 1) + "]"); + } + + this._colourList.set(index, vColour); + } + + /** + * + * + * @param vColourArray + */ + public void setColour(final Colour[] vColourArray) + { + // -- copy array + _colourList.clear(); + + for (int i = 0; i < vColourArray.length; i++) + { + this._colourList.add(vColourArray[i]); + } + } + + /** + * Sets the value of field 'schemeName'. + * + * @param schemeName + * the value of field 'schemeName'. + */ + public void setSchemeName(final java.lang.String schemeName) + { + this._schemeName = schemeName; + } + + /** + * Sets the value of field 'version'. The field 'version' has the following + * description: Jalview colour scheme document version. + * + * + * @param version + * the value of field 'version'. + */ + public void setVersion(final java.lang.String version) + { + this._version = version; + } + + /** + * Method unmarshal. + * + * @param reader + * @throws org.exolab.castor.xml.MarshalException + * if object is null or if any SAXException is thrown during + * marshaling + * @throws org.exolab.castor.xml.ValidationException + * if this object is an invalid instance according to the schema + * @return the unmarshaled jalview.schemabinding.version2.JalviewUserColours + */ + public static jalview.schemabinding.version2.JalviewUserColours unmarshal( + final java.io.Reader reader) + throws org.exolab.castor.xml.MarshalException, + org.exolab.castor.xml.ValidationException + { + return (jalview.schemabinding.version2.JalviewUserColours) Unmarshaller + .unmarshal( + jalview.schemabinding.version2.JalviewUserColours.class, + reader); + } + + /** + * + * + * @throws org.exolab.castor.xml.ValidationException + * if this object is an invalid instance according to the schema + */ + public void validate() throws org.exolab.castor.xml.ValidationException + { + org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator(); + validator.validate(this); + } + +}