src/jalview/binding/UserColours.java

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