src/jalview/binding/Residue.java

   1 /*\r
   2  * This class was automatically generated with\r
   3  * <a href="http://www.castor.org">Castor 0.9.6</a>, using an XML\r
   4  * Schema.\r
   5  * $Id$\r
   6  */\r
   7 /*\r
   8 * Jalview - A Sequence Alignment Editor and Viewer\r
   9 * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
  10 *\r
  11 * This program is free software; you can redistribute it and/or\r
  12 * modify it under the terms of the GNU General Public License\r
  13 * as published by the Free Software Foundation; either version 2\r
  14 * of the License, or (at your option) any later version.\r
  15 *\r
  16 * This program is distributed in the hope that it will be useful,\r
  17 * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  19 * GNU General Public License for more details.\r
  20 *\r
  21 * You should have received a copy of the GNU General Public License\r
  22 * along with this program; if not, write to the Free Software\r
  23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
  24 */\r
  25 package jalview.binding;\r
  26 \r
  27 import org.exolab.castor.xml.MarshalException;\r
  28 import org.exolab.castor.xml.Marshaller;\r
  29 import org.exolab.castor.xml.Unmarshaller;\r
  30 import org.exolab.castor.xml.ValidationException;\r
  31 \r
  32 import org.xml.sax.ContentHandler;\r
  33 \r
  34 //---------------------------------/\r
  35 //- Imported classes and packages -/\r
  36 //---------------------------------/\r
  37 import java.io.IOException;\r
  38 import java.io.Reader;\r
  39 import java.io.Serializable;\r
  40 import java.io.Writer;\r
  41 \r
  42 \r
  43 /**\r
  44  * Class Residue.\r
  45  *\r
  46  * @version $Revision$ $Date$\r
  47  */\r
  48 public class Residue implements java.io.Serializable {\r
  49     //--------------------------/\r
  50     //- Class/Member Variables -/\r
  51     //--------------------------/\r
  52 \r
  53     /**\r
  54      * Field _name\r
  55      */\r
  56     private java.lang.String _name;\r
  57 \r
  58     /**\r
  59      * Field _RGB\r
  60      */\r
  61     private int _RGB;\r
  62 \r
  63     /**\r
  64      * keeps track of state for field: _RGB\r
  65      */\r
  66     private boolean _has_RGB;\r
  67 \r
  68     //----------------/\r
  69     //- Constructors -/\r
  70     //----------------/\r
  71     public Residue() {\r
  72         super();\r
  73     }\r
  74      //-- jalview.binding.Residue()\r
  75  //-----------/\r
  76 \r
  77     public void deleteRGB() {\r
  78         this._has_RGB = false;\r
  79     }\r
  80      //-- void deleteRGB()\r
  81 \r
  82     /**\r
  83      * Returns the value of field 'name'.\r
  84      *\r
  85      * @return String\r
  86      * @return the value of field 'name'.\r
  87      */\r
  88     public java.lang.String getName() {\r
  89         return this._name;\r
  90     }\r
  91      //-- java.lang.String getName()\r
  92 \r
  93     /**\r
  94      * Returns the value of field 'RGB'.\r
  95      *\r
  96      * @return int\r
  97      * @return the value of field 'RGB'.\r
  98      */\r
  99     public int getRGB() {\r
 100         return this._RGB;\r
 101     }\r
 102      //-- int getRGB()\r
 103 \r
 104     /**\r
 105      * Method hasRGB\r
 106      *\r
 107      *\r
 108      *\r
 109      * @return boolean\r
 110      */\r
 111     public boolean hasRGB() {\r
 112         return this._has_RGB;\r
 113     }\r
 114      //-- boolean hasRGB()\r
 115 \r
 116     /**\r
 117      * Method isValid\r
 118      *\r
 119      *\r
 120      *\r
 121      * @return boolean\r
 122      */\r
 123     public boolean isValid() {\r
 124         try {\r
 125             validate();\r
 126         } catch (org.exolab.castor.xml.ValidationException vex) {\r
 127             return false;\r
 128         }\r
 129 \r
 130         return true;\r
 131     }\r
 132      //-- boolean isValid()\r
 133 \r
 134     /**\r
 135      * Method marshal\r
 136      *\r
 137      *\r
 138      *\r
 139      * @param out\r
 140      */\r
 141     public void marshal(java.io.Writer out)\r
 142         throws org.exolab.castor.xml.MarshalException, \r
 143             org.exolab.castor.xml.ValidationException {\r
 144         Marshaller.marshal(this, out);\r
 145     }\r
 146      //-- void marshal(java.io.Writer)\r
 147 \r
 148     /**\r
 149      * Method marshal\r
 150      *\r
 151      *\r
 152      *\r
 153      * @param handler\r
 154      */\r
 155     public void marshal(org.xml.sax.ContentHandler handler)\r
 156         throws java.io.IOException, org.exolab.castor.xml.MarshalException, \r
 157             org.exolab.castor.xml.ValidationException {\r
 158         Marshaller.marshal(this, handler);\r
 159     }\r
 160      //-- void marshal(org.xml.sax.ContentHandler)\r
 161 \r
 162     /**\r
 163      * Sets the value of field 'name'.\r
 164      *\r
 165      * @param name the value of field 'name'.\r
 166      */\r
 167     public void setName(java.lang.String name) {\r
 168         this._name = name;\r
 169     }\r
 170      //-- void setName(java.lang.String)\r
 171 \r
 172     /**\r
 173      * Sets the value of field 'RGB'.\r
 174      *\r
 175      * @param RGB the value of field 'RGB'.\r
 176      */\r
 177     public void setRGB(int RGB) {\r
 178         this._RGB = RGB;\r
 179         this._has_RGB = true;\r
 180     }\r
 181      //-- void setRGB(int)\r
 182 \r
 183     /**\r
 184      * Method unmarshal\r
 185      *\r
 186      *\r
 187      *\r
 188      * @param reader\r
 189      * @return Object\r
 190      */\r
 191     public static java.lang.Object unmarshal(java.io.Reader reader)\r
 192         throws org.exolab.castor.xml.MarshalException, \r
 193             org.exolab.castor.xml.ValidationException {\r
 194         return (jalview.binding.Residue) Unmarshaller.unmarshal(jalview.binding.Residue.class,\r
 195             reader);\r
 196     }\r
 197      //-- java.lang.Object unmarshal(java.io.Reader)\r
 198 \r
 199     /**\r
 200      * Method validate\r
 201      *\r
 202      */\r
 203     public void validate() throws org.exolab.castor.xml.ValidationException {\r
 204         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
 205         validator.validate(this);\r
 206     }\r
 207      //-- void validate()\r
 208 }\r