com.puppycrawl.tools.checkstyle.checks.naming
Class MethodNameCheck

java.lang.Object
  com.puppycrawl.tools.checkstyle.api.AutomaticBean
      com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
          com.puppycrawl.tools.checkstyle.api.Check
              com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck
                  com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck
                      com.puppycrawl.tools.checkstyle.checks.naming.MethodNameCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class MethodNameCheck

extends AbstractNameCheck

Checks that method names conform to a format specified by the format property. The format is a regular expression and defaults to ^[a-z][a-zA-Z0-9]*$.

An example of how to configure the check is:

 <module name="MethodName"/>
 

An example of how to configure the check for names that begin with a lower case letter, followed by letters, digits, and underscores is:

 <module name="MethodName">
    <property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/>
 </module>
 

Version:

1.0

Author:

Oliver Burn

Constructor Summary

MethodNameCheck()
Creates a new MethodNameCheck instance.

Method Summary

int[]

getDefaultTokens() Returns the default token a check is interested in.

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck

mustCheckName, visitToken

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck

getFormat, getRegexp, setFormat

Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MethodNameCheck

public MethodNameCheck()

Creates a new MethodNameCheck instance.

Method Detail

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: Check

Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.

Specified by:

getDefaultTokens in class Check

Returns:

the default tokens

See Also:

Check