public class CatchParameterNameCheck extends AbstractNameCheck
Checks that catch
parameter names conform to a format specified by the format property.
The format is a regular expression
and defaults to
^(e|t|ex|[a-z][a-z][a-zA-Z]+)$.
Default pattern has the following characteristic:
e
abbreviation (suitable for exceptions end errors)ex
abbreviation (suitable for exceptions)t
abbreviation (suitable for throwables)e1
or t2
pException
ie
or ee
An example of how to configure the check is:
<module name="CatchParameterName"/>
An example of how to configure the check for names that begin with a lower case letter, followed by any letters or digits is:
<module name="CatchParameterName"> <property name="format" value="^[a-z][a-zA-Z0-9]+$"/> </module>
MSG_INVALID_PATTERN
Constructor and Description |
---|
CatchParameterNameCheck()
Creates a new
CatchParameterNameCheck instance. |
Modifier and Type | Method and Description |
---|---|
int[] |
getAcceptableTokens()
The configurable token set.
|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
int[] |
getRequiredTokens()
The tokens that this check must be registered for.
|
protected boolean |
mustCheckName(DetailAST ast)
Decides whether the name of an AST should be checked against
the format regexp.
|
setFormat, visitToken
beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public CatchParameterNameCheck()
CatchParameterNameCheck
instance.public int[] getDefaultTokens()
Check
getDefaultTokens
in class Check
TokenTypes
public int[] getAcceptableTokens()
Check
getAcceptableTokens
in class Check
TokenTypes
public int[] getRequiredTokens()
Check
getRequiredTokens
in class Check
TokenTypes
protected boolean mustCheckName(DetailAST ast)
AbstractNameCheck
mustCheckName
in class AbstractNameCheck
ast
- the AST to check.Copyright © 2001–2020. All rights reserved.