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  
46  package org.codehaus.modello.plugin.java.javasource;
47  
48  /*
49   * Copyright (c) 2004, Codehaus.org
50   *
51   * Permission is hereby granted, free of charge, to any person obtaining a copy of
52   * this software and associated documentation files (the "Software"), to deal in
53   * the Software without restriction, including without limitation the rights to
54   * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
55   * of the Software, and to permit persons to whom the Software is furnished to do
56   * so, subject to the following conditions:
57   *
58   * The above copyright notice and this permission notice shall be included in all
59   * copies or substantial portions of the Software.
60   *
61   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
62   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
63   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
64   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
65   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
66   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
67   * SOFTWARE.
68   */
69  
70  /**
71   * A utility class used to validate identifiers
72   * and class names
73   * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
74   * @version $Revision$ $Date$
75   **/
76  class JNaming
77  {
78  
79      private static final String[] keywords = {
80          "abstract",
81          "boolean",
82          "break",
83          "byte",
84          "case",
85          "catch",
86          "char",
87          "class",
88          "const",
89          "continue",
90          "default",
91          "do",
92          "double",
93          "else",
94          "extends",
95          "false",
96          "final",
97          "finally",
98          "float",
99          "for",
100         "goto",
101         "if",
102         "implements",
103         "import",
104         "instanceof",
105         "int",
106         "interface",
107         "long",
108         "native",
109         "new",
110         "null",
111         "package",
112         "private",
113         "protected",
114         "public",
115         "return",
116         "short",
117         "static",
118         "super",
119         "switch",
120         "synchronized",
121         "this",
122         "throw",
123         "throws",
124         "transient",
125         "true",
126         "try",
127         "void",
128         "volatile",
129         "while"
130     }; //-- keywords
131 
132 
133     private JNaming()
134     {
135         super();
136     }
137 
138     /**
139      * Returns true if the given String is a Java keyword which
140      * will cause a problem when used as a variable name
141      **/
142     public static boolean isKeyword( String name )
143     {
144         if ( name == null ) return false;
145         for ( String keyword : keywords )
146         {
147             if ( keyword.equals( name ) )
148             {
149                 return true;
150             }
151         }
152         return false;
153     } //-- isKeyword
154 
155     /**
156      * Returns true if the given String matches the
157      * production of a valid Java identifier
158      *
159      * @param string, the String to check the production of
160      * @return true if the given String matches the
161      * production of a valid Java name, otherwise false
162      **/
163     public static boolean isValidJavaIdentifier( String string )
164     {
165 
166         if ( ( string == null ) || ( string.length() == 0 ) )
167             return false;
168 
169         char[] chars = string.toCharArray();
170 
171         //-- make sure starting character is valid
172         if ( !Character.isJavaIdentifierStart( chars[0] ) )
173             return false;
174 
175         for ( int i = 1; i < chars.length; i++ )
176         {
177             if ( !Character.isJavaIdentifierPart( chars[i] ) )
178                 return false;
179         }
180         if ( isKeyword( string ) ) return false;
181         return true;
182     } //-- isValidJavaIdentifier
183 
184 } //-- JNaming