src/jalview/binding/UserColours.java

   1 /*
   2  * This class was automatically generated with
   3  * <a href="http://www.castor.org">Castor 1.1</a>, using an XML
   4  * Schema.
   5  * $Id$
   6  */
   7
   8 package jalview.binding;
   9
  10 //---------------------------------/
  11 //- Imported classes and packages -/
  12 //---------------------------------/
  13
  14 import org.exolab.castor.xml.Marshaller;
  15 import org.exolab.castor.xml.Unmarshaller;
  16
  17 /**
  18  * Class UserColours.
  19  *
  20  * @version $Revision$ $Date$
  21  */
  22 public class UserColours implements java.io.Serializable
  23 {
  24
  25   // --------------------------/
  26   // - Class/Member Variables -/
  27   // --------------------------/
  28
  29   /**
  30    * Field _id.
  31    */
  32   private java.lang.String _id;
  33
  34   /**
  35    * Field _userColourScheme.
  36    */
  37   private jalview.binding.UserColourScheme _userColourScheme;
  38
  39   // ----------------/
  40   // - Constructors -/
  41   // ----------------/
  42
  43   public UserColours()
  44   {
  45     super();
  46   }
  47
  48   // -----------/
  49   // - Methods -/
  50   // -----------/
  51
  52   /**
  53    * Returns the value of field 'id'.
  54    *
  55    * @return the value of field 'Id'.
  56    */
  57   public java.lang.String getId()
  58   {
  59     return this._id;
  60   }
  61
  62   /**
  63    * Returns the value of field 'userColourScheme'.
  64    *
  65    * @return the value of field 'UserColourScheme'.
  66    */
  67   public jalview.binding.UserColourScheme getUserColourScheme()
  68   {
  69     return this._userColourScheme;
  70   }
  71
  72   /**
  73    * Method isValid.
  74    *
  75    * @return true if this object is valid according to the schema
  76    */
  77   public boolean isValid()
  78   {
  79     try
  80     {
  81       validate();
  82     } catch (org.exolab.castor.xml.ValidationException vex)
  83     {
  84       return false;
  85     }
  86     return true;
  87   }
  88
  89   /**
  90    *
  91    *
  92    * @param out
  93    * @throws org.exolab.castor.xml.MarshalException
  94    *           if object is null or if any SAXException is thrown during
  95    *           marshaling
  96    * @throws org.exolab.castor.xml.ValidationException
  97    *           if this object is an invalid instance according to the schema
  98    */
  99   public void marshal(final java.io.Writer out)
 100           throws org.exolab.castor.xml.MarshalException,
 101           org.exolab.castor.xml.ValidationException
 102   {
 103     Marshaller.marshal(this, out);
 104   }
 105
 106   /**
 107    *
 108    *
 109    * @param handler
 110    * @throws java.io.IOException
 111    *           if an IOException occurs during marshaling
 112    * @throws org.exolab.castor.xml.ValidationException
 113    *           if this object is an invalid instance according to the schema
 114    * @throws org.exolab.castor.xml.MarshalException
 115    *           if object is null or if any SAXException is thrown during
 116    *           marshaling
 117    */
 118   public void marshal(final org.xml.sax.ContentHandler handler)
 119           throws java.io.IOException,
 120           org.exolab.castor.xml.MarshalException,
 121           org.exolab.castor.xml.ValidationException
 122   {
 123     Marshaller.marshal(this, handler);
 124   }
 125
 126   /**
 127    * Sets the value of field 'id'.
 128    *
 129    * @param id
 130    *          the value of field 'id'.
 131    */
 132   public void setId(final java.lang.String id)
 133   {
 134     this._id = id;
 135   }
 136
 137   /**
 138    * Sets the value of field 'userColourScheme'.
 139    *
 140    * @param userColourScheme
 141    *          the value of field 'userColourScheme'
 142    */
 143   public void setUserColourScheme(
 144           final jalview.binding.UserColourScheme userColourScheme)
 145   {
 146     this._userColourScheme = userColourScheme;
 147   }
 148
 149   /**
 150    * Method unmarshal.
 151    *
 152    * @param reader
 153    * @throws org.exolab.castor.xml.MarshalException
 154    *           if object is null or if any SAXException is thrown during
 155    *           marshaling
 156    * @throws org.exolab.castor.xml.ValidationException
 157    *           if this object is an invalid instance according to the schema
 158    * @return the unmarshaled jalview.binding.UserColours
 159    */
 160   public static jalview.binding.UserColours unmarshal(
 161           final java.io.Reader reader)
 162           throws org.exolab.castor.xml.MarshalException,
 163           org.exolab.castor.xml.ValidationException
 164   {
 165     return (jalview.binding.UserColours) Unmarshaller.unmarshal(
 166             jalview.binding.UserColours.class, reader);
 167   }
 168
 169   /**
 170    *
 171    *
 172    * @throws org.exolab.castor.xml.ValidationException
 173    *           if this object is an invalid instance according to the schema
 174    */
 175   public void validate() throws org.exolab.castor.xml.ValidationException
 176   {
 177     org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
 178     validator.validate(this);
 179   }
 180
 181 }