View Javadoc
1   /*
2    * Copyright 2006 Edward Kuns
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.exolab.castor.xml;
17  
18  /**
19   * Constants used by all of Castor-XML are defined here.
20   *
21   * @author <a href="mailto:edward.kuns@aspect.com">Edward Kuns</a>
22   * @version $Revision: 0000 $ $Date: $
23   */
24  public interface XMLConstants {
25      /** Descriptors are placed into this special package relative to the generated source. */
26      String DESCRIPTOR_PACKAGE  = "descriptors";
27  
28      /** This suffix is added to a class name to make its descriptor. */
29      String DESCRIPTOR_SUFFIX   = "Descriptor";
30  
31      /** Whitespace preserve (keep exactly as-is). */
32      String WHITESPACE_PRESERVE = "preserve";
33  
34      /** Whitespace replace (replace each whitespace with a blank). */
35      String WHITESPACE_REPLACE  = "replace";
36  
37      /** Whitespace collapse (replace each whitespace with a blank, remove leading
38       * and trailing whitespace, collapse consecutive blanks into exactly one blank). */
39      String WHITESPACE_COLLAPSE = "collapse";
40  
41      /** XML name type NCName. (non-colonized name.) */
42      short NAME_TYPE_NCNAME  = 0;
43  
44      /** XML name type NMTOKEN. (name token.) */
45      short NAME_TYPE_NMTOKEN = 1;
46  
47      /** XML name type CDATA. (character data.)*/
48      short NAME_TYPE_CDATA   = 2;
49  
50      /** XML name type QNAME. (qualified name.) */
51      short NAME_TYPE_QNAME   = 3;
52  
53      /** name of per package mapping file. */
54      String PKG_MAPPING_FILE = ".castor.xml";
55      
56      /** name of the class descriptor resolver file. */
57      String PKG_CDR_LIST_FILE = ".castor.cdr";
58  }