/*\r
- * This class was automatically generated with\r
- * <a href="http://www.castor.org">Castor 0.9.6</a>, using an XML\r
- * Schema.\r
- * $Id$\r
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5.1)\r
+ * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle\r
+ * \r
+ * This file is part of Jalview.\r
+ * \r
+ * Jalview is free software: you can redistribute it and/or\r
+ * modify it under the terms of the GNU General Public License \r
+ * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\r
+ * \r
+ * Jalview is distributed in the hope that it will be useful, but \r
+ * WITHOUT ANY WARRANTY; without even the implied warranty \r
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR \r
+ * PURPOSE. See the GNU General Public License for more details.\r
+ * \r
+ * You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.\r
*/\r
-\r
package jalview.schemabinding.version2;\r
\r
//---------------------------------/\r
//- Imported classes and packages -/\r
//---------------------------------/\r
\r
-import org.exolab.castor.xml.*;\r
+import org.exolab.castor.xml.Marshaller;\r
+import org.exolab.castor.xml.Unmarshaller;\r
\r
/**\r
* Class AnnotationElement.\r
- *\r
+ * \r
* @version $Revision$ $Date$\r
*/\r
-public class AnnotationElement\r
- implements java.io.Serializable\r
+public class AnnotationElement implements java.io.Serializable\r
{\r
\r
- //--------------------------/\r
- //- Class/Member Variables -/\r
- //--------------------------/\r
+ // --------------------------/\r
+ // - Class/Member Variables -/\r
+ // --------------------------/\r
\r
/**\r
- * Field _position\r
+ * Field _position.\r
*/\r
private int _position;\r
\r
private boolean _has_position;\r
\r
/**\r
- * Field _colour\r
+ * Field _colour.\r
*/\r
private int _colour;\r
\r
private boolean _has_colour;\r
\r
/**\r
- * Field _displayCharacter\r
+ * Field _displayCharacter.\r
*/\r
private java.lang.String _displayCharacter;\r
\r
/**\r
- * Field _description\r
+ * Field _description.\r
*/\r
private java.lang.String _description;\r
\r
/**\r
- * Field _secondaryStructure\r
+ * Field _secondaryStructure.\r
*/\r
private java.lang.String _secondaryStructure;\r
\r
/**\r
- * Field _value\r
+ * Field _value.\r
*/\r
private float _value;\r
\r
*/\r
private boolean _has_value;\r
\r
- //----------------/\r
- //- Constructors -/\r
- //----------------/\r
+ // ----------------/\r
+ // - Constructors -/\r
+ // ----------------/\r
\r
public AnnotationElement()\r
{\r
super();\r
- } //-- jalview.schemabinding.version2.AnnotationElement()\r
+ }\r
\r
- //-----------/\r
- //- Methods -/\r
- //-----------/\r
+ // -----------/\r
+ // - Methods -/\r
+ // -----------/\r
\r
/**\r
- * Method deleteColour\r
- *\r
- */\r
+ */\r
public void deleteColour()\r
{\r
this._has_colour = false;\r
- } //-- void deleteColour()\r
+ }\r
\r
/**\r
- * Method deletePosition\r
- *\r
- */\r
+ */\r
public void deletePosition()\r
{\r
this._has_position = false;\r
- } //-- void deletePosition()\r
+ }\r
\r
/**\r
- * Method deleteValue\r
- *\r
- */\r
+ */\r
public void deleteValue()\r
{\r
this._has_value = false;\r
- } //-- void deleteValue()\r
+ }\r
\r
/**\r
* Returns the value of field 'colour'.\r
- *\r
- * @return int\r
- * @return the value of field 'colour'.\r
+ * \r
+ * @return the value of field 'Colour'.\r
*/\r
public int getColour()\r
{\r
return this._colour;\r
- } //-- int getColour()\r
+ }\r
\r
/**\r
* Returns the value of field 'description'.\r
- *\r
- * @return String\r
- * @return the value of field 'description'.\r
+ * \r
+ * @return the value of field 'Description'.\r
*/\r
public java.lang.String getDescription()\r
{\r
return this._description;\r
- } //-- java.lang.String getDescription()\r
+ }\r
\r
/**\r
* Returns the value of field 'displayCharacter'.\r
- *\r
- * @return String\r
- * @return the value of field 'displayCharacter'.\r
+ * \r
+ * @return the value of field 'DisplayCharacter'.\r
*/\r
public java.lang.String getDisplayCharacter()\r
{\r
return this._displayCharacter;\r
- } //-- java.lang.String getDisplayCharacter()\r
+ }\r
\r
/**\r
* Returns the value of field 'position'.\r
- *\r
- * @return int\r
- * @return the value of field 'position'.\r
+ * \r
+ * @return the value of field 'Position'.\r
*/\r
public int getPosition()\r
{\r
return this._position;\r
- } //-- int getPosition()\r
+ }\r
\r
/**\r
* Returns the value of field 'secondaryStructure'.\r
- *\r
- * @return String\r
- * @return the value of field 'secondaryStructure'.\r
+ * \r
+ * @return the value of field 'SecondaryStructure'.\r
*/\r
public java.lang.String getSecondaryStructure()\r
{\r
return this._secondaryStructure;\r
- } //-- java.lang.String getSecondaryStructure()\r
+ }\r
\r
/**\r
* Returns the value of field 'value'.\r
- *\r
- * @return float\r
- * @return the value of field 'value'.\r
+ * \r
+ * @return the value of field 'Value'.\r
*/\r
public float getValue()\r
{\r
return this._value;\r
- } //-- float getValue()\r
+ }\r
\r
/**\r
- * Method hasColour\r
- *\r
- *\r
- *\r
- * @return boolean\r
+ * Method hasColour.\r
+ * \r
+ * @return true if at least one Colour has been added\r
*/\r
public boolean hasColour()\r
{\r
return this._has_colour;\r
- } //-- boolean hasColour()\r
+ }\r
\r
/**\r
- * Method hasPosition\r
- *\r
- *\r
- *\r
- * @return boolean\r
+ * Method hasPosition.\r
+ * \r
+ * @return true if at least one Position has been added\r
*/\r
public boolean hasPosition()\r
{\r
return this._has_position;\r
- } //-- boolean hasPosition()\r
+ }\r
\r
/**\r
- * Method hasValue\r
- *\r
- *\r
- *\r
- * @return boolean\r
+ * Method hasValue.\r
+ * \r
+ * @return true if at least one Value has been added\r
*/\r
public boolean hasValue()\r
{\r
return this._has_value;\r
- } //-- boolean hasValue()\r
+ }\r
\r
/**\r
- * Method isValid\r
- *\r
- *\r
- *\r
- * @return boolean\r
+ * Method isValid.\r
+ * \r
+ * @return true if this object is valid according to the schema\r
*/\r
public boolean isValid()\r
{\r
try\r
{\r
validate();\r
- }\r
- catch (org.exolab.castor.xml.ValidationException vex)\r
+ } catch (org.exolab.castor.xml.ValidationException vex)\r
{\r
return false;\r
}\r
return true;\r
- } //-- boolean isValid()\r
+ }\r
\r
/**\r
- * Method marshal\r
- *\r
- *\r
- *\r
+ * \r
+ * \r
* @param out\r
- */\r
- public void marshal(java.io.Writer out)\r
- throws org.exolab.castor.xml.MarshalException,\r
- org.exolab.castor.xml.ValidationException\r
+ * @throws org.exolab.castor.xml.MarshalException\r
+ * if object is null or if any SAXException is thrown during\r
+ * marshaling\r
+ * @throws org.exolab.castor.xml.ValidationException\r
+ * if this object is an invalid instance according to the schema\r
+ */\r
+ public void marshal(final java.io.Writer out)\r
+ throws org.exolab.castor.xml.MarshalException,\r
+ org.exolab.castor.xml.ValidationException\r
{\r
-\r
Marshaller.marshal(this, out);\r
- } //-- void marshal(java.io.Writer)\r
+ }\r
\r
/**\r
- * Method marshal\r
- *\r
- *\r
- *\r
+ * \r
+ * \r
* @param handler\r
- */\r
- public void marshal(org.xml.sax.ContentHandler handler)\r
- throws java.io.IOException, org.exolab.castor.xml.MarshalException,\r
- org.exolab.castor.xml.ValidationException\r
+ * @throws java.io.IOException\r
+ * if an IOException occurs during marshaling\r
+ * @throws org.exolab.castor.xml.ValidationException\r
+ * if this object is an invalid instance according to the schema\r
+ * @throws org.exolab.castor.xml.MarshalException\r
+ * if object is null or if any SAXException is thrown during\r
+ * marshaling\r
+ */\r
+ public void marshal(final org.xml.sax.ContentHandler handler)\r
+ throws java.io.IOException,\r
+ org.exolab.castor.xml.MarshalException,\r
+ org.exolab.castor.xml.ValidationException\r
{\r
-\r
Marshaller.marshal(this, handler);\r
- } //-- void marshal(org.xml.sax.ContentHandler)\r
+ }\r
\r
/**\r
* Sets the value of field 'colour'.\r
- *\r
- * @param colour the value of field 'colour'.\r
+ * \r
+ * @param colour\r
+ * the value of field 'colour'.\r
*/\r
- public void setColour(int colour)\r
+ public void setColour(final int colour)\r
{\r
this._colour = colour;\r
this._has_colour = true;\r
- } //-- void setColour(int)\r
+ }\r
\r
/**\r
* Sets the value of field 'description'.\r
- *\r
- * @param description the value of field 'description'.\r
+ * \r
+ * @param description\r
+ * the value of field 'description'.\r
*/\r
- public void setDescription(java.lang.String description)\r
+ public void setDescription(final java.lang.String description)\r
{\r
this._description = description;\r
- } //-- void setDescription(java.lang.String)\r
+ }\r
\r
/**\r
* Sets the value of field 'displayCharacter'.\r
- *\r
- * @param displayCharacter the value of field 'displayCharacter'\r
+ * \r
+ * @param displayCharacter\r
+ * the value of field 'displayCharacter'\r
*/\r
- public void setDisplayCharacter(java.lang.String displayCharacter)\r
+ public void setDisplayCharacter(final java.lang.String displayCharacter)\r
{\r
this._displayCharacter = displayCharacter;\r
- } //-- void setDisplayCharacter(java.lang.String)\r
+ }\r
\r
/**\r
* Sets the value of field 'position'.\r
- *\r
- * @param position the value of field 'position'.\r
+ * \r
+ * @param position\r
+ * the value of field 'position'.\r
*/\r
- public void setPosition(int position)\r
+ public void setPosition(final int position)\r
{\r
this._position = position;\r
this._has_position = true;\r
- } //-- void setPosition(int)\r
+ }\r
\r
/**\r
* Sets the value of field 'secondaryStructure'.\r
- *\r
- * @param secondaryStructure the value of field\r
- * 'secondaryStructure'.\r
+ * \r
+ * @param secondaryStructure\r
+ * the value of field 'secondaryStructure'.\r
*/\r
- public void setSecondaryStructure(java.lang.String secondaryStructure)\r
+ public void setSecondaryStructure(\r
+ final java.lang.String secondaryStructure)\r
{\r
this._secondaryStructure = secondaryStructure;\r
- } //-- void setSecondaryStructure(java.lang.String)\r
+ }\r
\r
/**\r
* Sets the value of field 'value'.\r
- *\r
- * @param value the value of field 'value'.\r
+ * \r
+ * @param value\r
+ * the value of field 'value'.\r
*/\r
- public void setValue(float value)\r
+ public void setValue(final float value)\r
{\r
this._value = value;\r
this._has_value = true;\r
- } //-- void setValue(float)\r
+ }\r
\r
/**\r
- * Method unmarshal\r
- *\r
- *\r
- *\r
+ * Method unmarshal.\r
+ * \r
* @param reader\r
- * @return Object\r
- */\r
- public static java.lang.Object unmarshal(java.io.Reader reader)\r
- throws org.exolab.castor.xml.MarshalException,\r
- org.exolab.castor.xml.ValidationException\r
+ * @throws org.exolab.castor.xml.MarshalException\r
+ * if object is null or if any SAXException is thrown during\r
+ * marshaling\r
+ * @throws org.exolab.castor.xml.ValidationException\r
+ * if this object is an invalid instance according to the schema\r
+ * @return the unmarshaled jalview.schemabinding.version2.AnnotationElement\r
+ */\r
+ public static jalview.schemabinding.version2.AnnotationElement unmarshal(\r
+ final java.io.Reader reader)\r
+ throws org.exolab.castor.xml.MarshalException,\r
+ org.exolab.castor.xml.ValidationException\r
{\r
- return (jalview.schemabinding.version2.AnnotationElement) Unmarshaller.\r
- unmarshal(jalview.schemabinding.version2.AnnotationElement.class,\r
- reader);\r
- } //-- java.lang.Object unmarshal(java.io.Reader)\r
+ return (jalview.schemabinding.version2.AnnotationElement) Unmarshaller\r
+ .unmarshal(\r
+ jalview.schemabinding.version2.AnnotationElement.class,\r
+ reader);\r
+ }\r
\r
/**\r
- * Method validate\r
- *\r
+ * \r
+ * \r
+ * @throws org.exolab.castor.xml.ValidationException\r
+ * if this object is an invalid instance according to the schema\r
*/\r
- public void validate()\r
- throws org.exolab.castor.xml.ValidationException\r
+ public void validate() throws org.exolab.castor.xml.ValidationException\r
{\r
- org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.\r
- Validator();\r
+ org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
validator.validate(this);\r
- } //-- void validate()\r
+ }\r
\r
}\r
git://source.jalview.org / jalview.git / blobdiff