KickJava   Java API By Example, From Geeks To Geeks.

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


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.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  * {@link java.util.regex.Pattern regular expression}
29  * 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="ParameterName"/&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="ParameterName"&gt;
44  * &lt;property name="format" value="^^[a-z](_?[a-zA-Z0-9]+)*$"/&gt;
45  * &lt;/module&gt;
46  * </pre>
47  *
48  * @author Oliver Burn
49  */
50 public class ParameterNameCheck
51     extends AbstractNameCheck
52 {
53     /**
54      * Creates a new <code>ParameterNameCheck</code> instance.
55      */
56     public ParameterNameCheck()
57     {
58         super("^[a-z][a-zA-Z0-9]*$");
59     }
60
61     /** {@inheritDoc} */
62     public int[] getDefaultTokens()
63     {
64         return new int[] {TokenTypes.PARAMETER_DEF};
65     }
66
67     /** {@inheritDoc} */
68     protected boolean mustCheckName(DetailAST aAST)
69     {
70         return !(
71             (aAST.getParent() != null)
72                 && (aAST.getParent().getType() == TokenTypes.LITERAL_CATCH));
73     }
74 }
75
Popular Tags