KickJava   Java API By Example, From Geeks To Geeks.

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


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.DetailAST;
22 import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
23 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
24
25 /**
26  * <p>
27  * Checks that static, non-final variable names conform to a format specified
28  * by the format property. The format is a
29  * {@link java.util.regex.Pattern regular expression} and defaults to
30  * <strong>^[a-z][a-zA-Z0-9]*$</strong>.
31  * </p>
32  * <p>
33  * An example of how to configure the check is:
34  * </p>
35  * <pre>
36  * &lt;module name="StaticVariableName"/&gt;
37  * </pre>
38  * <p>
39  * An example of how to configure the check for names that begin with
40  * a lower case letter, followed by letters, digits, and underscores is:
41  * </p>
42  * <pre>
43  * &lt;module name="StaticVariableName"&gt;
44  * &lt;property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/&gt;
45  * &lt;/module&gt;
46  * </pre>
47  * @author Rick Giles
48  * @version 1.0
49  */
50 public class StaticVariableNameCheck
51     extends AbstractNameCheck
52 {
53     /** Creates a new <code>StaticVariableNameCheck</code> instance. */
54     public StaticVariableNameCheck()
55     {
56         super("^[a-z][a-zA-Z0-9]*$");
57     }
58
59     /** {@inheritDoc} */
60     public int[] getDefaultTokens()
61     {
62         return new int[] {TokenTypes.VARIABLE_DEF};
63     }
64
65     /** {@inheritDoc} */
66     protected final boolean mustCheckName(DetailAST aAST)
67     {
68         final DetailAST modifiersAST =
69             aAST.findFirstToken(TokenTypes.MODIFIERS);
70         final boolean isStatic = (modifiersAST != null)
71             && modifiersAST.branchContains(TokenTypes.LITERAL_STATIC);
72         final boolean isFinal = (modifiersAST != null)
73             && modifiersAST.branchContains(TokenTypes.FINAL);
74
75         return (isStatic
76                 && !isFinal
77                 && !ScopeUtils.inInterfaceOrAnnotationBlock(aAST));
78     }
79 }
80
Popular Tags