src/jalview/schemabinding/version2/UserColourScheme.java

   1 /*\r
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4.1)\r
   3  * Copyright (C) 2009 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
   4  * \r
   5  * This program is free software; you can redistribute it and/or\r
   6  * modify it under the terms of the GNU General Public License\r
   7  * as published by the Free Software Foundation; either version 2\r
   8  * of the License, or (at your option) any later version.\r
   9  * \r
  10  * This program is distributed in the hope that it will be useful,\r
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  13  * GNU General Public License for more details.\r
  14  * \r
  15  * You should have received a copy of the GNU General Public License\r
  16  * along with this program; if not, write to the Free Software\r
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
  18  */\r
  19 package jalview.schemabinding.version2;\r
  20 \r
  21   //---------------------------------/\r
  22  //- Imported classes and packages -/\r
  23 //---------------------------------/\r
  24 \r
  25 import org.exolab.castor.xml.Marshaller;\r
  26 import org.exolab.castor.xml.Unmarshaller;\r
  27 \r
  28 /**\r
  29  * Class UserColourScheme.\r
  30  * \r
  31  * @version $Revision$ $Date$\r
  32  */\r
  33 public class UserColourScheme extends JalviewUserColours \r
  34 implements java.io.Serializable\r
  35 {\r
  36 \r
  37 \r
  38       //----------------/\r
  39      //- Constructors -/\r
  40     //----------------/\r
  41 \r
  42     public UserColourScheme() {\r
  43         super();\r
  44     }\r
  45 \r
  46 \r
  47       //-----------/\r
  48      //- Methods -/\r
  49     //-----------/\r
  50 \r
  51     /**\r
  52      * Method isValid.\r
  53      * \r
  54      * @return true if this object is valid according to the schema\r
  55      */\r
  56     public boolean isValid(\r
  57     ) {\r
  58         try {\r
  59             validate();\r
  60         } catch (org.exolab.castor.xml.ValidationException vex) {\r
  61             return false;\r
  62         }\r
  63         return true;\r
  64     }\r
  65 \r
  66     /**\r
  67      * \r
  68      * \r
  69      * @param out\r
  70      * @throws org.exolab.castor.xml.MarshalException if object is\r
  71      * null or if any SAXException is thrown during marshaling\r
  72      * @throws org.exolab.castor.xml.ValidationException if this\r
  73      * object is an invalid instance according to the schema\r
  74      */\r
  75     public void marshal(\r
  76             final java.io.Writer out)\r
  77     throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
  78         Marshaller.marshal(this, out);\r
  79     }\r
  80 \r
  81     /**\r
  82      * \r
  83      * \r
  84      * @param handler\r
  85      * @throws java.io.IOException if an IOException occurs during\r
  86      * marshaling\r
  87      * @throws org.exolab.castor.xml.ValidationException if this\r
  88      * object is an invalid instance according to the schema\r
  89      * @throws org.exolab.castor.xml.MarshalException if object is\r
  90      * null or if any SAXException is thrown during marshaling\r
  91      */\r
  92     public void marshal(\r
  93             final org.xml.sax.ContentHandler handler)\r
  94     throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
  95         Marshaller.marshal(this, handler);\r
  96     }\r
  97 \r
  98     /**\r
  99      * Method unmarshal.\r
 100      * \r
 101      * @param reader\r
 102      * @throws org.exolab.castor.xml.MarshalException if object is\r
 103      * null or if any SAXException is thrown during marshaling\r
 104      * @throws org.exolab.castor.xml.ValidationException if this\r
 105      * object is an invalid instance according to the schema\r
 106      * @return the unmarshaled\r
 107      * jalview.schemabinding.version2.JalviewUserColours\r
 108      */\r
 109     public static jalview.schemabinding.version2.JalviewUserColours unmarshal(\r
 110             final java.io.Reader reader)\r
 111     throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
 112         return (jalview.schemabinding.version2.JalviewUserColours) Unmarshaller.unmarshal(jalview.schemabinding.version2.UserColourScheme.class, reader);\r
 113     }\r
 114 \r
 115     /**\r
 116      * \r
 117      * \r
 118      * @throws org.exolab.castor.xml.ValidationException if this\r
 119      * object is an invalid instance according to the schema\r
 120      */\r
 121     public void validate(\r
 122     )\r
 123     throws org.exolab.castor.xml.ValidationException {\r
 124         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
 125         validator.validate(this);\r
 126     }\r
 127 \r
 128 }\r