2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)
3 * Copyright (C) 2008 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;
55 public UserColours() {
65 * Returns the value of field 'id'.
67 * @return the value of field 'Id'.
69 public java.lang.String getId(
75 * Returns the value of field 'userColourScheme'.
77 * @return the value of field 'UserColourScheme'.
79 public jalview.binding.UserColourScheme getUserColourScheme(
81 return this._userColourScheme;
87 * @return true if this object is valid according to the schema
89 public boolean isValid(
93 } catch (org.exolab.castor.xml.ValidationException vex) {
103 * @throws org.exolab.castor.xml.MarshalException if object is
104 * null or if any SAXException is thrown during marshaling
105 * @throws org.exolab.castor.xml.ValidationException if this
106 * object is an invalid instance according to the schema
109 final java.io.Writer out)
110 throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
111 Marshaller.marshal(this, out);
118 * @throws java.io.IOException if an IOException occurs during
120 * @throws org.exolab.castor.xml.ValidationException if this
121 * object is an invalid instance according to the schema
122 * @throws org.exolab.castor.xml.MarshalException if object is
123 * null or if any SAXException is thrown during marshaling
126 final org.xml.sax.ContentHandler handler)
127 throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
128 Marshaller.marshal(this, handler);
132 * Sets the value of field 'id'.
134 * @param id the value of field 'id'.
137 final java.lang.String id) {
142 * Sets the value of field 'userColourScheme'.
144 * @param userColourScheme the value of field 'userColourScheme'
146 public void setUserColourScheme(
147 final jalview.binding.UserColourScheme userColourScheme) {
148 this._userColourScheme = userColourScheme;
155 * @throws org.exolab.castor.xml.MarshalException if object is
156 * null or if any SAXException is thrown during marshaling
157 * @throws org.exolab.castor.xml.ValidationException if this
158 * object is an invalid instance according to the schema
159 * @return the unmarshaled jalview.binding.UserColours
161 public static jalview.binding.UserColours unmarshal(
162 final java.io.Reader reader)
163 throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
164 return (jalview.binding.UserColours) Unmarshaller.unmarshal(jalview.binding.UserColours.class, reader);
170 * @throws org.exolab.castor.xml.ValidationException if this
171 * object is an invalid instance according to the schema
173 public void validate(
175 throws org.exolab.castor.xml.ValidationException {
176 org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
177 validator.validate(this);