View Javadoc
1   /**
2    * Redistribution and use of this software and associated documentation
3    * ("Software"), with or without modification, are permitted provided
4    * that the following conditions are met:
5    *
6    * 1. Redistributions of source code must retain copyright
7    *    statements and notices.  Redistributions must also contain a
8    *    copy of this document.
9    *
10   * 2. Redistributions in binary form must reproduce the
11   *    above copyright notice, this list of conditions and the
12   *    following disclaimer in the documentation and/or other
13   *    materials provided with the distribution.
14   *
15   * 3. The name "Exolab" must not be used to endorse or promote
16   *    products derived from this Software without prior written
17   *    permission of Intalio, Inc.  For written permission,
18   *    please contact info@codehaus.org.
19   *
20   * 4. Products derived from this Software may not be called "Exolab"
21   *    nor may "Exolab" appear in their names without prior written
22   *    permission of Intalio, Inc. Exolab is a registered
23   *    trademark of Intalio, Inc.
24   *
25   * 5. Due credit should be given to the Exolab Project
26   *    (http://www.codehaus.org/).
27   *
28   * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS
29   * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30   * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
32   * INTALIO, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33   * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39   * OF THE POSSIBILITY OF SUCH DAMAGE.
40   *
41   * Copyright 1999-2000 (C) Intalio, Inc. All Rights Reserved.
42   *
43   * $Id$
44   */
45  package org.codehaus.modello.plugin.java.javasource;
46  
47  /*
48   * Copyright (c) 2004, Codehaus.org
49   *
50   * Permission is hereby granted, free of charge, to any person obtaining a copy of
51   * this software and associated documentation files (the "Software"), to deal in
52   * the Software without restriction, including without limitation the rights to
53   * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
54   * of the Software, and to permit persons to whom the Software is furnished to do
55   * so, subject to the following conditions:
56   *
57   * The above copyright notice and this permission notice shall be included in all
58   * copies or substantial portions of the Software.
59   *
60   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
61   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
62   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
63   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
64   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
65   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
66   * SOFTWARE.
67   */
68  
69  /**
70   * A utility class used to validate identifiers
71   * and class names
72   * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
73   * @version $Revision$ $Date$
74   **/
75  class JNaming {
76  
77      private static final String[] keywords = {
78          "abstract",
79          "boolean",
80          "break",
81          "byte",
82          "case",
83          "catch",
84          "char",
85          "class",
86          "const",
87          "continue",
88          "default",
89          "do",
90          "double",
91          "else",
92          "extends",
93          "false",
94          "final",
95          "finally",
96          "float",
97          "for",
98          "goto",
99          "if",
100         "implements",
101         "import",
102         "instanceof",
103         "int",
104         "interface",
105         "long",
106         "native",
107         "new",
108         "null",
109         "package",
110         "private",
111         "protected",
112         "public",
113         "return",
114         "short",
115         "static",
116         "super",
117         "switch",
118         "synchronized",
119         "this",
120         "throw",
121         "throws",
122         "transient",
123         "true",
124         "try",
125         "void",
126         "volatile",
127         "while"
128     }; // -- keywords
129 
130     private JNaming() {
131         super();
132     }
133 
134     /**
135      * Returns true if the given String is a Java keyword which
136      * will cause a problem when used as a variable name
137      **/
138     public static boolean isKeyword(String name) {
139         if (name == null) return false;
140         for (String keyword : keywords) {
141             if (keyword.equals(name)) {
142                 return true;
143             }
144         }
145         return false;
146     } // -- isKeyword
147 
148     /**
149      * Returns true if the given String matches the
150      * production of a valid Java identifier
151      *
152      * @param string, the String to check the production of
153      * @return true if the given String matches the
154      * production of a valid Java name, otherwise false
155      **/
156     public static boolean isValidJavaIdentifier(String string) {
157 
158         if ((string == null) || (string.length() == 0)) return false;
159 
160         char[] chars = string.toCharArray();
161 
162         // -- make sure starting character is valid
163         if (!Character.isJavaIdentifierStart(chars[0])) return false;
164 
165         for (int i = 1; i < chars.length; i++) {
166             if (!Character.isJavaIdentifierPart(chars[i])) return false;
167         }
168         if (isKeyword(string)) return false;
169         return true;
170     } // -- isValidJavaIdentifier
171 } // -- JNaming