2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1)
3 * Copyright (C) 2014 The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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 * The Jalview Authors are detailed in the 'AUTHORS' file.
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 schema
110 public void marshal(final java.io.Writer out)
111 throws org.exolab.castor.xml.MarshalException,
112 org.exolab.castor.xml.ValidationException
114 Marshaller.marshal(this, out);
121 * @throws java.io.IOException
122 * if an IOException occurs during marshaling
123 * @throws org.exolab.castor.xml.ValidationException
124 * if this object is an invalid instance according to the schema
125 * @throws org.exolab.castor.xml.MarshalException
126 * if object is null or if any SAXException is thrown during
129 public void marshal(final org.xml.sax.ContentHandler handler)
130 throws java.io.IOException,
131 org.exolab.castor.xml.MarshalException,
132 org.exolab.castor.xml.ValidationException
134 Marshaller.marshal(this, handler);
138 * Sets the value of field 'id'.
141 * the value of field 'id'.
143 public void setId(final java.lang.String id)
149 * Sets the value of field 'userColourScheme'.
151 * @param userColourScheme
152 * the value of field 'userColourScheme'
154 public void setUserColourScheme(
155 final jalview.binding.UserColourScheme userColourScheme)
157 this._userColourScheme = userColourScheme;
164 * @throws org.exolab.castor.xml.MarshalException
165 * if object is null or if any SAXException is thrown during
167 * @throws org.exolab.castor.xml.ValidationException
168 * if this object is an invalid instance according to the schema
169 * @return the unmarshaled jalview.binding.UserColours
171 public static jalview.binding.UserColours unmarshal(
172 final java.io.Reader reader)
173 throws org.exolab.castor.xml.MarshalException,
174 org.exolab.castor.xml.ValidationException
176 return (jalview.binding.UserColours) Unmarshaller.unmarshal(
177 jalview.binding.UserColours.class, reader);
183 * @throws org.exolab.castor.xml.ValidationException
184 * if this object is an invalid instance according to the schema
186 public void validate() throws org.exolab.castor.xml.ValidationException
188 org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
189 validator.validate(this);