X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fbinding%2FJalviewUserColours.java;fp=src%2Fjalview%2Fbinding%2FJalviewUserColours.java;h=0000000000000000000000000000000000000000;hb=aace9d05c0870c703bfdfb28c1608213cee019bf;hp=67ee5a2cb1cafd8ef08c167596622abbc545ce1a;hpb=2a3bac30ae8290e912eb7ffe7ff7ec700b6cfaac;p=jalview.git diff --git a/src/jalview/binding/JalviewUserColours.java b/src/jalview/binding/JalviewUserColours.java deleted file mode 100644 index 67ee5a2..0000000 --- a/src/jalview/binding/JalviewUserColours.java +++ /dev/null @@ -1,503 +0,0 @@ -/* - * This class was automatically generated with - * Castor 1.1, using an XML - * Schema. - * $Id$ - */ - -package jalview.binding; - -//---------------------------------/ -//- 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; - - /** - * Field _filterList. - */ - private java.util.Vector _filterList; - - // ----------------/ - // - Constructors -/ - // ----------------/ - - public JalviewUserColours() - { - super(); - this._colourList = new java.util.Vector(); - this._filterList = 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); - } - - /** - * - * - * @param vFilter - * @throws java.lang.IndexOutOfBoundsException - * if the index given is outside the bounds of the collection - */ - public void addFilter(final Filter vFilter) - throws java.lang.IndexOutOfBoundsException - { - this._filterList.addElement(vFilter); - } - - /** - * - * - * @param index - * @param vFilter - * @throws java.lang.IndexOutOfBoundsException - * if the index given is outside the bounds of the collection - */ - public void addFilter(final int index, final Filter vFilter) - throws java.lang.IndexOutOfBoundsException - { - this._filterList.add(index, vFilter); - } - - /** - * Method enumerateColour. - * - * @return an Enumeration over all Colour elements - */ - public java.util.Enumeration enumerateColour() - { - return this._colourList.elements(); - } - - /** - * Method enumerateFilter. - * - * @return an Enumeration over all Filter elements - */ - public java.util.Enumeration enumerateFilter() - { - return this._filterList.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(); - } - - /** - * Method getFilter. - * - * @param index - * @throws java.lang.IndexOutOfBoundsException - * if the index given is outside the bounds of the collection - * @return the value of the Filter at the given index - */ - public Filter getFilter(final int index) - throws java.lang.IndexOutOfBoundsException - { - // check bounds for index - if (index < 0 || index >= this._filterList.size()) - { - throw new IndexOutOfBoundsException( - "getFilter: Index value '" + index + "' not in range [0.." - + (this._filterList.size() - 1) + "]"); - } - - return (Filter) _filterList.get(index); - } - - /** - * Method getFilter.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 Filter[] getFilter() - { - Filter[] array = new Filter[0]; - return (Filter[]) this._filterList.toArray(array); - } - - /** - * Method getFilterCount. - * - * @return the size of this collection - */ - public int getFilterCount() - { - return this._filterList.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(); - } - - /** - */ - public void removeAllFilter() - { - this._filterList.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; - } - - /** - * Method removeFilter. - * - * @param vFilter - * @return true if the object was removed from the collection. - */ - public boolean removeFilter(final Filter vFilter) - { - boolean removed = _filterList.remove(vFilter); - return removed; - } - - /** - * Method removeFilterAt. - * - * @param index - * @return the element removed from the collection - */ - public Filter removeFilterAt(final int index) - { - java.lang.Object obj = this._filterList.remove(index); - return (Filter) 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]); - } - } - - /** - * - * - * @param index - * @param vFilter - * @throws java.lang.IndexOutOfBoundsException - * if the index given is outside the bounds of the collection - */ - public void setFilter(final int index, final Filter vFilter) - throws java.lang.IndexOutOfBoundsException - { - // check bounds for index - if (index < 0 || index >= this._filterList.size()) - { - throw new IndexOutOfBoundsException( - "setFilter: Index value '" + index + "' not in range [0.." - + (this._filterList.size() - 1) + "]"); - } - - this._filterList.set(index, vFilter); - } - - /** - * - * - * @param vFilterArray - */ - public void setFilter(final Filter[] vFilterArray) - { - // -- copy array - _filterList.clear(); - - for (int i = 0; i < vFilterArray.length; i++) - { - this._filterList.add(vFilterArray[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.binding.JalviewUserColours - */ - public static jalview.binding.JalviewUserColours unmarshal( - final 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); - } - - /** - * - * - * @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); - } - -}