Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

com.puppycrawl.tools.checkstyle.checks.naming

Class MethodNameCheck

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()

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, setCompileFlags, setFormat

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

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

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

getId, getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, log, log, setId, setSeverity

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

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Constructor Details

MethodNameCheck

public MethodNameCheck()
Creates a new MethodNameCheck instance.

Method Details

getDefaultTokens

public int[] getDefaultTokens()
Overrides:
getDefaultTokens in interface Check

Overview Package Class Use Tree Index Deprecated About
Back to the Checkstyle Home Page