KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > puppycrawl > tools > checkstyle > checks > naming > TypeNameCheck


1 ////////////////////////////////////////////////////////////////////////////////
2
// checkstyle: Checks Java source code for adherence to a set of rules.
3
// Copyright (C) 2001-2005 Oliver Burn
4
//
5
// This library is free software; you can redistribute it and/or
6
// modify it under the terms of the GNU Lesser General Public
7
// License as published by the Free Software Foundation; either
8
// version 2.1 of the License, or (at your option) any later version.
9
//
10
// This library is distributed in the hope that it will be useful,
11
// but WITHOUT ANY WARRANTY; without even the implied warranty of
12
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13
// Lesser General Public License for more details.
14
//
15
// You should have received a copy of the GNU Lesser General Public
16
// License along with this library; if not, write to the Free Software
17
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
////////////////////////////////////////////////////////////////////////////////
19
package com.puppycrawl.tools.checkstyle.checks.naming;
20
21 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
22
23 /**
24  * <p>
25  * Checks that type names conform to a format specified
26  * by the format property. The format is a
27  * {@link java.util.regex.Pattern regular expression} and defaults to
28  * <strong>^[A-Z][a-zA-Z0-9]*$</strong>.
29  * </p>
30  * <p>
31  * An example of how to configure the check is:
32  * </p>
33  * <pre>
34  * &lt;module name="TypeName"/&gt;
35  * </pre>
36  * <p>
37  * An example of how to configure the check for names that begin with
38  * a lower case letter, followed by letters, digits, and underscores is:
39  * </p>
40  * <pre>
41  * &lt;module name="TypeName"&gt;
42  * &lt;property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/&gt;
43  * &lt;/module&gt;
44  * </pre>
45  * @author Oliver Burn
46  */

47 public class TypeNameCheck
48     extends AbstractNameCheck
49 {
50
51     /**
52      * Creates a new <code>TypeNameCheck</code> instance.
53      */

54     public TypeNameCheck()
55     {
56         super("^[A-Z][a-zA-Z0-9]*$");
57     }
58
59     /** {@inheritDoc} */
60     public int[] getDefaultTokens()
61     {
62         return new int[] {TokenTypes.CLASS_DEF,
63                           TokenTypes.INTERFACE_DEF, };
64     }
65 }
66
Popular Tags