added help and documentation for annotation editing.
[jalview.git] / src / jalview / binding / UserColours.java
1 /*\r
2  * This class was automatically generated with\r
3  * <a href="http://www.castor.org">Castor 0.9.6</a>, using an XML\r
4  * Schema.\r
5  * $Id$\r
6  */\r
7 \r
8 package jalview.binding;\r
9 \r
10 //---------------------------------/\r
11 //- Imported classes and packages -/\r
12 //---------------------------------/\r
13 \r
14 import org.exolab.castor.xml.*;\r
15 \r
16 /**\r
17  * Class UserColours.\r
18  *\r
19  * @version $Revision$ $Date$\r
20  */\r
21 public class UserColours\r
22     implements java.io.Serializable\r
23 {\r
24 \r
25   //--------------------------/\r
26   //- Class/Member Variables -/\r
27   //--------------------------/\r
28 \r
29   /**\r
30    * Field _id\r
31    */\r
32   private java.lang.String _id;\r
33 \r
34   /**\r
35    * Field _userColourScheme\r
36    */\r
37   private jalview.binding.UserColourScheme _userColourScheme;\r
38 \r
39   //----------------/\r
40   //- Constructors -/\r
41   //----------------/\r
42 \r
43   public UserColours()\r
44   {\r
45     super();\r
46   } //-- jalview.binding.UserColours()\r
47 \r
48   //-----------/\r
49   //- Methods -/\r
50   //-----------/\r
51 \r
52   /**\r
53    * Returns the value of field 'id'.\r
54    *\r
55    * @return String\r
56    * @return the value of field 'id'.\r
57    */\r
58   public java.lang.String getId()\r
59   {\r
60     return this._id;\r
61   } //-- java.lang.String getId()\r
62 \r
63   /**\r
64    * Returns the value of field 'userColourScheme'.\r
65    *\r
66    * @return UserColourScheme\r
67    * @return the value of field 'userColourScheme'.\r
68    */\r
69   public jalview.binding.UserColourScheme getUserColourScheme()\r
70   {\r
71     return this._userColourScheme;\r
72   } //-- jalview.binding.UserColourScheme getUserColourScheme()\r
73 \r
74   /**\r
75    * Method isValid\r
76    *\r
77    *\r
78    *\r
79    * @return boolean\r
80    */\r
81   public boolean isValid()\r
82   {\r
83     try\r
84     {\r
85       validate();\r
86     }\r
87     catch (org.exolab.castor.xml.ValidationException vex)\r
88     {\r
89       return false;\r
90     }\r
91     return true;\r
92   } //-- boolean isValid()\r
93 \r
94   /**\r
95    * Method marshal\r
96    *\r
97    *\r
98    *\r
99    * @param out\r
100    */\r
101   public void marshal(java.io.Writer out)\r
102       throws org.exolab.castor.xml.MarshalException,\r
103       org.exolab.castor.xml.ValidationException\r
104   {\r
105 \r
106     Marshaller.marshal(this, out);\r
107   } //-- void marshal(java.io.Writer)\r
108 \r
109   /**\r
110    * Method marshal\r
111    *\r
112    *\r
113    *\r
114    * @param handler\r
115    */\r
116   public void marshal(org.xml.sax.ContentHandler handler)\r
117       throws java.io.IOException, org.exolab.castor.xml.MarshalException,\r
118       org.exolab.castor.xml.ValidationException\r
119   {\r
120 \r
121     Marshaller.marshal(this, handler);\r
122   } //-- void marshal(org.xml.sax.ContentHandler)\r
123 \r
124   /**\r
125    * Sets the value of field 'id'.\r
126    *\r
127    * @param id the value of field 'id'.\r
128    */\r
129   public void setId(java.lang.String id)\r
130   {\r
131     this._id = id;\r
132   } //-- void setId(java.lang.String)\r
133 \r
134   /**\r
135    * Sets the value of field 'userColourScheme'.\r
136    *\r
137    * @param userColourScheme the value of field 'userColourScheme'\r
138    */\r
139   public void setUserColourScheme(jalview.binding.UserColourScheme\r
140                                   userColourScheme)\r
141   {\r
142     this._userColourScheme = userColourScheme;\r
143   } //-- void setUserColourScheme(jalview.binding.UserColourScheme)\r
144 \r
145   /**\r
146    * Method unmarshal\r
147    *\r
148    *\r
149    *\r
150    * @param reader\r
151    * @return Object\r
152    */\r
153   public static java.lang.Object unmarshal(java.io.Reader reader)\r
154       throws org.exolab.castor.xml.MarshalException,\r
155       org.exolab.castor.xml.ValidationException\r
156   {\r
157     return (jalview.binding.UserColours) Unmarshaller.unmarshal(jalview.binding.\r
158         UserColours.class, reader);\r
159   } //-- java.lang.Object unmarshal(java.io.Reader)\r
160 \r
161   /**\r
162    * Method validate\r
163    *\r
164    */\r
165   public void validate()\r
166       throws org.exolab.castor.xml.ValidationException\r
167   {\r
168     org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.\r
169         Validator();\r
170     validator.validate(this);\r
171   } //-- void validate()\r
172 \r
173 }\r