src/jalview/schemabinding/version2/UserColours.java

   1 /*******************************************************************************
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
   3  * Copyright (C) 2014 The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.
  17  * If not, see <http://www.gnu.org/licenses/>.
  18  * The Jalview Authors are detailed in the 'AUTHORS' file.
  19  ******************************************************************************/
  20 /*
  21  * This class was automatically generated with
  22  * <a href="http://www.castor.org">Castor 1.1</a>, using an XML
  23  * Schema.
  24  * $Id$
  25  */
  26
  27 package jalview.schemabinding.version2;
  28
  29 //---------------------------------/
  30 //- Imported classes and packages -/
  31 //---------------------------------/
  32
  33 import org.exolab.castor.xml.Marshaller;
  34 import org.exolab.castor.xml.Unmarshaller;
  35
  36 /**
  37  * Class UserColours.
  38  *
  39  * @version $Revision$ $Date$
  40  */
  41 public class UserColours implements java.io.Serializable
  42 {
  43
  44   // --------------------------/
  45   // - Class/Member Variables -/
  46   // --------------------------/
  47
  48   /**
  49    * Field _id.
  50    */
  51   private java.lang.String _id;
  52
  53   /**
  54    * Field _userColourScheme.
  55    */
  56   private jalview.schemabinding.version2.UserColourScheme _userColourScheme;
  57
  58   // ----------------/
  59   // - Constructors -/
  60   // ----------------/
  61
  62   public UserColours()
  63   {
  64     super();
  65   }
  66
  67   // -----------/
  68   // - Methods -/
  69   // -----------/
  70
  71   /**
  72    * Returns the value of field 'id'.
  73    *
  74    * @return the value of field 'Id'.
  75    */
  76   public java.lang.String getId()
  77   {
  78     return this._id;
  79   }
  80
  81   /**
  82    * Returns the value of field 'userColourScheme'.
  83    *
  84    * @return the value of field 'UserColourScheme'.
  85    */
  86   public jalview.schemabinding.version2.UserColourScheme getUserColourScheme()
  87   {
  88     return this._userColourScheme;
  89   }
  90
  91   /**
  92    * Method isValid.
  93    *
  94    * @return true if this object is valid according to the schema
  95    */
  96   public boolean isValid()
  97   {
  98     try
  99     {
 100       validate();
 101     } catch (org.exolab.castor.xml.ValidationException vex)
 102     {
 103       return false;
 104     }
 105     return true;
 106   }
 107
 108   /**
 109    *
 110    *
 111    * @param out
 112    * @throws org.exolab.castor.xml.MarshalException
 113    *           if object is null or if any SAXException is thrown during
 114    *           marshaling
 115    * @throws org.exolab.castor.xml.ValidationException
 116    *           if this object is an invalid instance according to the schema
 117    */
 118   public void marshal(final java.io.Writer out)
 119           throws org.exolab.castor.xml.MarshalException,
 120           org.exolab.castor.xml.ValidationException
 121   {
 122     Marshaller.marshal(this, out);
 123   }
 124
 125   /**
 126    *
 127    *
 128    * @param handler
 129    * @throws java.io.IOException
 130    *           if an IOException occurs during marshaling
 131    * @throws org.exolab.castor.xml.ValidationException
 132    *           if this object is an invalid instance according to the schema
 133    * @throws org.exolab.castor.xml.MarshalException
 134    *           if object is null or if any SAXException is thrown during
 135    *           marshaling
 136    */
 137   public void marshal(final org.xml.sax.ContentHandler handler)
 138           throws java.io.IOException,
 139           org.exolab.castor.xml.MarshalException,
 140           org.exolab.castor.xml.ValidationException
 141   {
 142     Marshaller.marshal(this, handler);
 143   }
 144
 145   /**
 146    * Sets the value of field 'id'.
 147    *
 148    * @param id
 149    *          the value of field 'id'.
 150    */
 151   public void setId(final java.lang.String id)
 152   {
 153     this._id = id;
 154   }
 155
 156   /**
 157    * Sets the value of field 'userColourScheme'.
 158    *
 159    * @param userColourScheme
 160    *          the value of field 'userColourScheme'
 161    */
 162   public void setUserColourScheme(
 163           final jalview.schemabinding.version2.UserColourScheme userColourScheme)
 164   {
 165     this._userColourScheme = userColourScheme;
 166   }
 167
 168   /**
 169    * Method unmarshal.
 170    *
 171    * @param reader
 172    * @throws org.exolab.castor.xml.MarshalException
 173    *           if object is null or if any SAXException is thrown during
 174    *           marshaling
 175    * @throws org.exolab.castor.xml.ValidationException
 176    *           if this object is an invalid instance according to the schema
 177    * @return the unmarshaled jalview.schemabinding.version2.UserColours
 178    */
 179   public static jalview.schemabinding.version2.UserColours unmarshal(
 180           final java.io.Reader reader)
 181           throws org.exolab.castor.xml.MarshalException,
 182           org.exolab.castor.xml.ValidationException
 183   {
 184     return (jalview.schemabinding.version2.UserColours) Unmarshaller
 185             .unmarshal(jalview.schemabinding.version2.UserColours.class,
 186                     reader);
 187   }
 188
 189   /**
 190    *
 191    *
 192    * @throws org.exolab.castor.xml.ValidationException
 193    *           if this object is an invalid instance according to the schema
 194    */
 195   public void validate() throws org.exolab.castor.xml.ValidationException
 196   {
 197     org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
 198     validator.validate(this);
 199   }
 200
 201 }