JAL-1620 version bump and release notes
[jalview.git] / src / jalview / schemabinding / version2 / descriptors / UserColoursDescriptor.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2b1)
3  * Copyright (C) 2014 The Jalview Authors
4  * 
5  * This file is part of Jalview.
6  * 
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
10  * of the License, or (at your option) any later version.
11  *  
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
19  * The Jalview Authors are detailed in the 'AUTHORS' file.
20  */
21 package jalview.schemabinding.version2.descriptors;
22
23 //---------------------------------/
24 //- Imported classes and packages -/
25 //---------------------------------/
26
27 import jalview.schemabinding.version2.UserColours;
28
29 /**
30  * Class UserColoursDescriptor.
31  * 
32  * @version $Revision$ $Date$
33  */
34 public class UserColoursDescriptor extends
35         org.exolab.castor.xml.util.XMLClassDescriptorImpl
36 {
37
38   // --------------------------/
39   // - Class/Member Variables -/
40   // --------------------------/
41
42   /**
43    * Field _elementDefinition.
44    */
45   private boolean _elementDefinition;
46
47   /**
48    * Field _nsPrefix.
49    */
50   private java.lang.String _nsPrefix;
51
52   /**
53    * Field _nsURI.
54    */
55   private java.lang.String _nsURI;
56
57   /**
58    * Field _xmlName.
59    */
60   private java.lang.String _xmlName;
61
62   // ----------------/
63   // - Constructors -/
64   // ----------------/
65
66   public UserColoursDescriptor()
67   {
68     super();
69     _nsURI = "www.jalview.org";
70     _xmlName = "UserColours";
71     _elementDefinition = true;
72
73     // -- set grouping compositor
74     setCompositorAsSequence();
75     org.exolab.castor.xml.util.XMLFieldDescriptorImpl desc = null;
76     org.exolab.castor.mapping.FieldHandler handler = null;
77     org.exolab.castor.xml.FieldValidator fieldValidator = null;
78     // -- initialize attribute descriptors
79
80     // -- _id
81     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
82             java.lang.String.class, "_id", "id",
83             org.exolab.castor.xml.NodeType.Attribute);
84     desc.setImmutable(true);
85     handler = new org.exolab.castor.xml.XMLFieldHandler()
86     {
87       public java.lang.Object getValue(java.lang.Object object)
88               throws IllegalStateException
89       {
90         UserColours target = (UserColours) object;
91         return target.getId();
92       }
93
94       public void setValue(java.lang.Object object, java.lang.Object value)
95               throws IllegalStateException, IllegalArgumentException
96       {
97         try
98         {
99           UserColours target = (UserColours) object;
100           target.setId((java.lang.String) value);
101         } catch (java.lang.Exception ex)
102         {
103           throw new IllegalStateException(ex.toString());
104         }
105       }
106
107       public java.lang.Object newInstance(java.lang.Object parent)
108       {
109         return null;
110       }
111     };
112     desc.setHandler(handler);
113     desc.setMultivalued(false);
114     addFieldDescriptor(desc);
115
116     // -- validation code for: _id
117     fieldValidator = new org.exolab.castor.xml.FieldValidator();
118     { // -- local scope
119       org.exolab.castor.xml.validators.StringValidator typeValidator;
120       typeValidator = new org.exolab.castor.xml.validators.StringValidator();
121       fieldValidator.setValidator(typeValidator);
122       typeValidator.setWhiteSpace("preserve");
123     }
124     desc.setValidator(fieldValidator);
125     // -- initialize element descriptors
126
127     // -- _userColourScheme
128     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
129             jalview.schemabinding.version2.UserColourScheme.class,
130             "_userColourScheme", "UserColourScheme",
131             org.exolab.castor.xml.NodeType.Element);
132     handler = new org.exolab.castor.xml.XMLFieldHandler()
133     {
134       public java.lang.Object getValue(java.lang.Object object)
135               throws IllegalStateException
136       {
137         UserColours target = (UserColours) object;
138         return target.getUserColourScheme();
139       }
140
141       public void setValue(java.lang.Object object, java.lang.Object value)
142               throws IllegalStateException, IllegalArgumentException
143       {
144         try
145         {
146           UserColours target = (UserColours) object;
147           target.setUserColourScheme((jalview.schemabinding.version2.UserColourScheme) value);
148         } catch (java.lang.Exception ex)
149         {
150           throw new IllegalStateException(ex.toString());
151         }
152       }
153
154       public java.lang.Object newInstance(java.lang.Object parent)
155       {
156         return new jalview.schemabinding.version2.UserColourScheme();
157       }
158     };
159     desc.setHandler(handler);
160     desc.setNameSpaceURI("www.jalview.org");
161     desc.setRequired(true);
162     desc.setMultivalued(false);
163     addFieldDescriptor(desc);
164
165     // -- validation code for: _userColourScheme
166     fieldValidator = new org.exolab.castor.xml.FieldValidator();
167     fieldValidator.setMinOccurs(1);
168     { // -- local scope
169     }
170     desc.setValidator(fieldValidator);
171   }
172
173   // -----------/
174   // - Methods -/
175   // -----------/
176
177   /**
178    * Method getAccessMode.
179    * 
180    * @return the access mode specified for this class.
181    */
182   public org.exolab.castor.mapping.AccessMode getAccessMode()
183   {
184     return null;
185   }
186
187   /**
188    * Method getIdentity.
189    * 
190    * @return the identity field, null if this class has no identity.
191    */
192   public org.exolab.castor.mapping.FieldDescriptor getIdentity()
193   {
194     return super.getIdentity();
195   }
196
197   /**
198    * Method getJavaClass.
199    * 
200    * @return the Java class represented by this descriptor.
201    */
202   public java.lang.Class getJavaClass()
203   {
204     return jalview.schemabinding.version2.UserColours.class;
205   }
206
207   /**
208    * Method getNameSpacePrefix.
209    * 
210    * @return the namespace prefix to use when marshaling as XML.
211    */
212   public java.lang.String getNameSpacePrefix()
213   {
214     return _nsPrefix;
215   }
216
217   /**
218    * Method getNameSpaceURI.
219    * 
220    * @return the namespace URI used when marshaling and unmarshaling as XML.
221    */
222   public java.lang.String getNameSpaceURI()
223   {
224     return _nsURI;
225   }
226
227   /**
228    * Method getValidator.
229    * 
230    * @return a specific validator for the class described by this
231    *         ClassDescriptor.
232    */
233   public org.exolab.castor.xml.TypeValidator getValidator()
234   {
235     return this;
236   }
237
238   /**
239    * Method getXMLName.
240    * 
241    * @return the XML Name for the Class being described.
242    */
243   public java.lang.String getXMLName()
244   {
245     return _xmlName;
246   }
247
248   /**
249    * Method isElementDefinition.
250    * 
251    * @return true if XML schema definition of this Class is that of a global
252    *         element or element with anonymous type definition.
253    */
254   public boolean isElementDefinition()
255   {
256     return _elementDefinition;
257   }
258
259 }