public class ParameterNameCheck extends AbstractNameCheck
Checks that parameter 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="ParameterName"/>
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="ParameterName">
<property name="format" value="^^[a-z](_?[a-zA-Z0-9]+)*$"/>
</module>
| Constructor and Description |
|---|
ParameterNameCheck()
Creates a new
ParameterNameCheck instance. |
| Modifier and Type | Method and Description |
|---|---|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
protected boolean |
mustCheckName(DetailAST aAST)
Decides whether the name of an AST should be checked against
the format regexp.
|
visitTokengetFormat, getRegexp, setCompileFlags, setFormatbeginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokensgetId, getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, setId, setSeverityconfigure, contextualize, finishLocalSetup, getConfiguration, setupChildpublic ParameterNameCheck()
ParameterNameCheck instance.public int[] getDefaultTokens()
getDefaultTokens in class CheckTokenTypesprotected boolean mustCheckName(DetailAST aAST)
mustCheckName in class AbstractNameCheckaAST - the AST to check.