Source code: com/puppycrawl/tools/checkstyle/checks/MethodNameCheck.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.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 * <a href="http://jakarta.apache.org/regexp/apidocs/org/apache/regexp/RE.html">
28 * regular expression</a>
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 * <module name="MethodName"/>
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 * <module name="MethodName">
44 * <property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/>
45 * </module>
46 * </pre>
47 * @author <a href="mailto:checkstyle@puppycrawl.com">Oliver Burn</a>
48 * @version 1.0
49 */
50 public class MethodNameCheck
51 extends AbstractNameCheck
52 {
53 /** Creates a new <code>MethodNameCheck</code> instance. */
54 public MethodNameCheck()
55 {
56 super("^[a-z][a-zA-Z0-9]*$");
57 }
58
59 /** @see com.puppycrawl.tools.checkstyle.api.Check */
60 public int[] getDefaultTokens()
61 {
62 return new int[] {TokenTypes.METHOD_DEF};
63 }
64 }