JAL-1432 updated copyright notices
[jalview.git] / src / jalview / schemabinding / version2 / descriptors / UserColourSchemeDescriptor.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
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 of the License, or (at your option) any later version.
10  *  
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.
15  * 
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.
18  */
19 package jalview.schemabinding.version2.descriptors;
20
21 //---------------------------------/
22 //- Imported classes and packages -/
23 //---------------------------------/
24
25 import jalview.schemabinding.version2.UserColourScheme;
26
27 /**
28  * Class UserColourSchemeDescriptor.
29  * 
30  * @version $Revision$ $Date$
31  */
32 public class UserColourSchemeDescriptor
33         extends
34         jalview.schemabinding.version2.descriptors.JalviewUserColoursDescriptor
35 {
36
37   // --------------------------/
38   // - Class/Member Variables -/
39   // --------------------------/
40
41   /**
42    * Field _elementDefinition.
43    */
44   private boolean _elementDefinition;
45
46   /**
47    * Field _nsPrefix.
48    */
49   private java.lang.String _nsPrefix;
50
51   /**
52    * Field _nsURI.
53    */
54   private java.lang.String _nsURI;
55
56   /**
57    * Field _xmlName.
58    */
59   private java.lang.String _xmlName;
60
61   // ----------------/
62   // - Constructors -/
63   // ----------------/
64
65   public UserColourSchemeDescriptor()
66   {
67     super();
68     setExtendsWithoutFlatten(new jalview.schemabinding.version2.descriptors.JalviewUserColoursDescriptor());
69     _nsURI = "www.jalview.org";
70     _xmlName = "UserColourScheme";
71     _elementDefinition = true;
72   }
73
74   // -----------/
75   // - Methods -/
76   // -----------/
77
78   /**
79    * Method getAccessMode.
80    * 
81    * @return the access mode specified for this class.
82    */
83   public org.exolab.castor.mapping.AccessMode getAccessMode()
84   {
85     return null;
86   }
87
88   /**
89    * Method getIdentity.
90    * 
91    * @return the identity field, null if this class has no identity.
92    */
93   public org.exolab.castor.mapping.FieldDescriptor getIdentity()
94   {
95     return super.getIdentity();
96   }
97
98   /**
99    * Method getJavaClass.
100    * 
101    * @return the Java class represented by this descriptor.
102    */
103   public java.lang.Class getJavaClass()
104   {
105     return jalview.schemabinding.version2.UserColourScheme.class;
106   }
107
108   /**
109    * Method getNameSpacePrefix.
110    * 
111    * @return the namespace prefix to use when marshaling as XML.
112    */
113   public java.lang.String getNameSpacePrefix()
114   {
115     return _nsPrefix;
116   }
117
118   /**
119    * Method getNameSpaceURI.
120    * 
121    * @return the namespace URI used when marshaling and unmarshaling as XML.
122    */
123   public java.lang.String getNameSpaceURI()
124   {
125     return _nsURI;
126   }
127
128   /**
129    * Method getValidator.
130    * 
131    * @return a specific validator for the class described by this
132    *         ClassDescriptor.
133    */
134   public org.exolab.castor.xml.TypeValidator getValidator()
135   {
136     return this;
137   }
138
139   /**
140    * Method getXMLName.
141    * 
142    * @return the XML Name for the Class being described.
143    */
144   public java.lang.String getXMLName()
145   {
146     return _xmlName;
147   }
148
149   /**
150    * Method isElementDefinition.
151    * 
152    * @return true if XML schema definition of this Class is that of a global
153    *         element or element with anonymous type definition.
154    */
155   public boolean isElementDefinition()
156   {
157     return _elementDefinition;
158   }
159
160 }