Source code: com/puppycrawl/tools/checkstyle/checks/ParameterNameCheck.java
1 ////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code for adherence to a set of rules.
3 // Copyright (C) 2001-2002 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;
20
21 import com.puppycrawl.tools.checkstyle.api.DetailAST;
22 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
23
24 /**
25 * <p>
26 * Checks that parameter names conform to a format specified
27 * by the format property. The format is a
28 * <a href="http://jakarta.apache.org/regexp/apidocs/org/apache/regexp/RE.html">
29 * regular expression</a>
30 * and defaults to
31 * <strong>^[a-z][a-zA-Z0-9]*$</strong>.
32 * </p>
33 * <p>
34 * An example of how to configure the check is:
35 * </p>
36 * <pre>
37 * <module name="ParameterName"/>
38 * </pre>
39 * <p>
40 * An example of how to configure the check for names that begin with
41 * a lower case letter, followed by letters, digits, and underscores is:
42 * </p>
43 * <pre>
44 * <module name="ParameterName">
45 * <property name="format" value="^^[a-z](_?[a-zA-Z0-9]+)*$"/>
46 * </module>
47
48 *
49 * @author Oliver Burn
50 */
51 public class ParameterNameCheck
52 extends AbstractNameCheck
53 {
54 /**
55 * Creates a new <code>ParameterNameCheck</code> instance.
56 */
57 public ParameterNameCheck()
58 {
59 super("^[a-z][a-zA-Z0-9]*$");
60 }
61
62 /** @see com.puppycrawl.tools.checkstyle.api.Check */
63 public int[] getDefaultTokens()
64 {
65 return new int[] {TokenTypes.PARAMETER_DEF};
66 }
67
68 /** @see com.puppycrawl.tools.checkstyle.checks.AbstractNameCheck */
69 protected boolean mustCheckName(DetailAST aAST)
70 {
71 return !(
72 (aAST.getParent() != null)
73 && (aAST.getParent().getType() == TokenTypes.LITERAL_CATCH));
74 }
75 }