KickJava   Java API By Example, From Geeks To Geeks.

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


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 method names conform to a format specified
26  * by the format property. The format is a
27  * {@link java.util.regex.Pattern regular expression}
28  * and defaults to
29  * <strong>^[a-z][a-zA-Z0-9]*$</strong>.
30  * </p>
31  * <p>
32  * An example of how to configure the check is:
33  * </p>
34  * <pre>
35  * &lt;module name="MethodName"/&gt;
36  * </pre>
37  * <p>
38  * An example of how to configure the check for names that begin with
39  * a lower case letter, followed by letters, digits, and underscores is:
40  * </p>
41  * <pre>
42  * &lt;module name="MethodName"&gt;
43  * &lt;property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/&gt;
44  * &lt;/module&gt;
45  * </pre>
46  * @author Oliver Burn
47  * @version 1.0
48  */
49 public class MethodNameCheck
50     extends AbstractNameCheck
51 {
52     /** Creates a new <code>MethodNameCheck</code> instance. */
53     public MethodNameCheck()
54     {
55         super("^[a-z][a-zA-Z0-9]*$");
56     }
57
58     /** {@inheritDoc} */
59     public int[] getDefaultTokens()
60     {
61         return new int[] {TokenTypes.METHOD_DEF};
62     }
63 }
64
Popular Tags