/*
* Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
* Copyright (C) $$Year-Rel$$ 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
* 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(MessageManager.formatMessage("exception.index_value_not_in_range", new String[]{ "setColour", Integer.valueOf(index).toString(), Integer.valueOf((this._colourList.size() - 1)).toString() })); } 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); } }