com.puppycrawl.tools.checkstyle.checks.naming
Class AbstractNameCheck
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
- All Implemented Interfaces:
- Configurable, Contextualizable
- Direct Known Subclasses:
- ConstantNameCheck, LocalFinalVariableNameCheck, LocalVariableNameCheck, MemberNameCheck, MethodNameCheck, ParameterNameCheck, StaticVariableNameCheck, TypeNameCheck
public abstract class AbstractNameCheck
- extends AbstractFormatCheck
Abstract class for checking that names conform to a specified format.
- Version:
- 1.0
- Author:
- Rick Giles
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 |
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 java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
AbstractNameCheck
public AbstractNameCheck(String aFormat)
- Creates a new
AbstractNameCheck
instance.
- Parameters:
aFormat
- format to check with
mustCheckName
protected boolean mustCheckName(DetailAST aAST)
- Decides whether the name of an AST should be checked against
the format regexp.
- Parameters:
aAST
- the AST to check.
- Returns:
- true if the IDENT subnode of aAST should be checked against
the format regexp.
visitToken
public void visitToken(DetailAST aAST)
- Called to process a token.
- Overrides:
visitToken
in class Check
- Parameters:
aAST
- the token to process