X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fschemabinding%2Fversion2%2FAnnotationColours.java;h=ff6dea7053aae53514ebfa9315f1b036f85ce16d;hb=506d60f0e188723ddc91c26824b41ac7034df3fe;hp=67d6ad865eaf1bd11ebff8f977f8c729cc882d24;hpb=7bc226b58110fa26d9dbd3f0c78095d06909ffc3;p=jalview.git diff --git a/src/jalview/schemabinding/version2/AnnotationColours.java b/src/jalview/schemabinding/version2/AnnotationColours.java index 67d6ad8..ff6dea7 100755 --- a/src/jalview/schemabinding/version2/AnnotationColours.java +++ b/src/jalview/schemabinding/version2/AnnotationColours.java @@ -1,33 +1,44 @@ /* - * This class was automatically generated with - * Castor 0.9.6, using an XML - * Schema. - * $Id$ + * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4) + * Copyright (C) 2008 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.schemabinding.version2; -//---------------------------------/ -//- Imported classes and packages -/ -//---------------------------------/ +// ---------------------------------/ +// - Imported classes and packages -/ +// ---------------------------------/ -import org.exolab.castor.xml.*; +import org.exolab.castor.xml.Marshaller; +import org.exolab.castor.xml.Unmarshaller; /** * Class AnnotationColours. - * + * * @version $Revision$ $Date$ */ -public class AnnotationColours - implements java.io.Serializable +public class AnnotationColours implements java.io.Serializable { - //--------------------------/ - //- Class/Member Variables -/ - //--------------------------/ + // --------------------------/ + // - Class/Member Variables -/ + // --------------------------/ /** - * Field _aboveThreshold + * Field _aboveThreshold. */ private int _aboveThreshold; @@ -37,12 +48,12 @@ public class AnnotationColours private boolean _has_aboveThreshold; /** - * Field _annotation + * Field _annotation. */ private java.lang.String _annotation; /** - * Field _minColour + * Field _minColour. */ private int _minColour; @@ -52,7 +63,7 @@ public class AnnotationColours private boolean _has_minColour; /** - * Field _maxColour + * Field _maxColour. */ private int _maxColour; @@ -62,12 +73,12 @@ public class AnnotationColours private boolean _has_maxColour; /** - * Field _colourScheme + * Field _colourScheme. */ private java.lang.String _colourScheme; /** - * Field _threshold + * Field _threshold. */ private float _threshold; @@ -76,310 +87,307 @@ public class AnnotationColours */ private boolean _has_threshold; - //----------------/ - //- Constructors -/ - //----------------/ + // ----------------/ + // - Constructors -/ + // ----------------/ public AnnotationColours() { super(); - } //-- jalview.schemabinding.version2.AnnotationColours() + } - //-----------/ - //- Methods -/ - //-----------/ + // -----------/ + // - Methods -/ + // -----------/ /** - * Method deleteAboveThreshold - * */ public void deleteAboveThreshold() { this._has_aboveThreshold = false; - } //-- void deleteAboveThreshold() + } /** - * Method deleteMaxColour - * */ public void deleteMaxColour() { this._has_maxColour = false; - } //-- void deleteMaxColour() + } /** - * Method deleteMinColour - * */ public void deleteMinColour() { this._has_minColour = false; - } //-- void deleteMinColour() + } /** - * Method deleteThreshold - * */ public void deleteThreshold() { this._has_threshold = false; - } //-- void deleteThreshold() + } /** * Returns the value of field 'aboveThreshold'. - * - * @return int - * @return the value of field 'aboveThreshold'. + * + * @return the value of field 'AboveThreshold'. */ public int getAboveThreshold() { return this._aboveThreshold; - } //-- int getAboveThreshold() + } /** * Returns the value of field 'annotation'. - * - * @return String - * @return the value of field 'annotation'. + * + * @return the value of field 'Annotation'. */ public java.lang.String getAnnotation() { return this._annotation; - } //-- java.lang.String getAnnotation() + } /** * Returns the value of field 'colourScheme'. - * - * @return String - * @return the value of field 'colourScheme'. + * + * @return the value of field 'ColourScheme'. */ public java.lang.String getColourScheme() { return this._colourScheme; - } //-- java.lang.String getColourScheme() + } /** * Returns the value of field 'maxColour'. - * - * @return int - * @return the value of field 'maxColour'. + * + * @return the value of field 'MaxColour'. */ public int getMaxColour() { return this._maxColour; - } //-- int getMaxColour() + } /** * Returns the value of field 'minColour'. - * - * @return int - * @return the value of field 'minColour'. + * + * @return the value of field 'MinColour'. */ public int getMinColour() { return this._minColour; - } //-- int getMinColour() + } /** * Returns the value of field 'threshold'. - * - * @return float - * @return the value of field 'threshold'. + * + * @return the value of field 'Threshold'. */ public float getThreshold() { return this._threshold; - } //-- float getThreshold() + } /** - * Method hasAboveThreshold - * - * - * - * @return boolean + * Method hasAboveThreshold. + * + * @return true if at least one AboveThreshold has been added */ public boolean hasAboveThreshold() { return this._has_aboveThreshold; - } //-- boolean hasAboveThreshold() + } /** - * Method hasMaxColour - * - * - * - * @return boolean + * Method hasMaxColour. + * + * @return true if at least one MaxColour has been added */ public boolean hasMaxColour() { return this._has_maxColour; - } //-- boolean hasMaxColour() + } /** - * Method hasMinColour - * - * - * - * @return boolean + * Method hasMinColour. + * + * @return true if at least one MinColour has been added */ public boolean hasMinColour() { return this._has_minColour; - } //-- boolean hasMinColour() + } /** - * Method hasThreshold - * - * - * - * @return boolean + * Method hasThreshold. + * + * @return true if at least one Threshold has been added */ public boolean hasThreshold() { return this._has_threshold; - } //-- boolean hasThreshold() + } /** - * Method isValid - * - * - * - * @return boolean + * 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) + } 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 + * @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); - } //-- 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 + * 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); - } //-- void marshal(org.xml.sax.ContentHandler) + } /** * Sets the value of field 'aboveThreshold'. - * - * @param aboveThreshold the value of field 'aboveThreshold'. + * + * @param aboveThreshold + * the value of field 'aboveThreshold'. */ - public void setAboveThreshold(int aboveThreshold) + public void setAboveThreshold(final int aboveThreshold) { this._aboveThreshold = aboveThreshold; this._has_aboveThreshold = true; - } //-- void setAboveThreshold(int) + } /** * Sets the value of field 'annotation'. - * - * @param annotation the value of field 'annotation'. + * + * @param annotation + * the value of field 'annotation'. */ - public void setAnnotation(java.lang.String annotation) + public void setAnnotation(final java.lang.String annotation) { this._annotation = annotation; - } //-- void setAnnotation(java.lang.String) + } /** * Sets the value of field 'colourScheme'. - * - * @param colourScheme the value of field 'colourScheme'. + * + * @param colourScheme + * the value of field 'colourScheme'. */ - public void setColourScheme(java.lang.String colourScheme) + public void setColourScheme(final java.lang.String colourScheme) { this._colourScheme = colourScheme; - } //-- void setColourScheme(java.lang.String) + } /** * Sets the value of field 'maxColour'. - * - * @param maxColour the value of field 'maxColour'. + * + * @param maxColour + * the value of field 'maxColour'. */ - public void setMaxColour(int maxColour) + public void setMaxColour(final int maxColour) { this._maxColour = maxColour; this._has_maxColour = true; - } //-- void setMaxColour(int) + } /** * Sets the value of field 'minColour'. - * - * @param minColour the value of field 'minColour'. + * + * @param minColour + * the value of field 'minColour'. */ - public void setMinColour(int minColour) + public void setMinColour(final int minColour) { this._minColour = minColour; this._has_minColour = true; - } //-- void setMinColour(int) + } /** * Sets the value of field 'threshold'. - * - * @param threshold the value of field 'threshold'. + * + * @param threshold + * the value of field 'threshold'. */ - public void setThreshold(float threshold) + public void setThreshold(final float threshold) { this._threshold = threshold; this._has_threshold = true; - } //-- void setThreshold(float) + } /** - * Method unmarshal - * - * - * + * 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 + * @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.AnnotationColours + */ + public static jalview.schemabinding.version2.AnnotationColours unmarshal( + final java.io.Reader reader) + throws org.exolab.castor.xml.MarshalException, + org.exolab.castor.xml.ValidationException { - return (jalview.schemabinding.version2.AnnotationColours) Unmarshaller. - unmarshal(jalview.schemabinding.version2.AnnotationColours.class, - reader); - } //-- java.lang.Object unmarshal(java.io.Reader) + return (jalview.schemabinding.version2.AnnotationColours) Unmarshaller + .unmarshal( + jalview.schemabinding.version2.AnnotationColours.class, + reader); + } /** - * Method validate - * + * + * + * @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 + public void validate() throws org.exolab.castor.xml.ValidationException { - org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml. - Validator(); + org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator(); validator.validate(this); - } //-- void validate() + } }