2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4.0.b2)
3 * Copyright (C) 2009 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
19 package jalview.binding;
21 // ---------------------------------/
22 // - Imported classes and packages -/
23 // ---------------------------------/
25 import org.exolab.castor.xml.Marshaller;
26 import org.exolab.castor.xml.Unmarshaller;
31 * @version $Revision$ $Date$
33 public class UserColours implements java.io.Serializable
36 // --------------------------/
37 // - Class/Member Variables -/
38 // --------------------------/
43 private java.lang.String _id;
46 * Field _userColourScheme.
48 private jalview.binding.UserColourScheme _userColourScheme;
64 * Returns the value of field 'id'.
66 * @return the value of field 'Id'.
68 public java.lang.String getId()
74 * Returns the value of field 'userColourScheme'.
76 * @return the value of field 'UserColourScheme'.
78 public jalview.binding.UserColourScheme getUserColourScheme()
80 return this._userColourScheme;
86 * @return true if this object is valid according to the schema
88 public boolean isValid()
93 } catch (org.exolab.castor.xml.ValidationException vex)
104 * @throws org.exolab.castor.xml.MarshalException
105 * if object is null or if any SAXException is thrown during
107 * @throws org.exolab.castor.xml.ValidationException
108 * if this object is an invalid instance according to the
111 public void marshal(final java.io.Writer out)
112 throws org.exolab.castor.xml.MarshalException,
113 org.exolab.castor.xml.ValidationException
115 Marshaller.marshal(this, out);
122 * @throws java.io.IOException
123 * if an IOException occurs during marshaling
124 * @throws org.exolab.castor.xml.ValidationException
125 * if this object is an invalid instance according to the
127 * @throws org.exolab.castor.xml.MarshalException
128 * if object is null or if any SAXException is thrown during
131 public void marshal(final org.xml.sax.ContentHandler handler)
132 throws java.io.IOException,
133 org.exolab.castor.xml.MarshalException,
134 org.exolab.castor.xml.ValidationException
136 Marshaller.marshal(this, handler);
140 * Sets the value of field 'id'.
143 * the value of field 'id'.
145 public void setId(final java.lang.String id)
151 * Sets the value of field 'userColourScheme'.
153 * @param userColourScheme
154 * the value of field 'userColourScheme'
156 public void setUserColourScheme(
157 final jalview.binding.UserColourScheme userColourScheme)
159 this._userColourScheme = userColourScheme;
166 * @throws org.exolab.castor.xml.MarshalException
167 * if object is null or if any SAXException is thrown during
169 * @throws org.exolab.castor.xml.ValidationException
170 * if this object is an invalid instance according to the
172 * @return the unmarshaled jalview.binding.UserColours
174 public static jalview.binding.UserColours unmarshal(
175 final java.io.Reader reader)
176 throws org.exolab.castor.xml.MarshalException,
177 org.exolab.castor.xml.ValidationException
179 return (jalview.binding.UserColours) Unmarshaller.unmarshal(
180 jalview.binding.UserColours.class, reader);
186 * @throws org.exolab.castor.xml.ValidationException
187 * if this object is an invalid instance according to the
190 public void validate() throws org.exolab.castor.xml.ValidationException
192 org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
193 validator.validate(this);