Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.puppycrawl.tools.checkstyle.checks
Class AbstractNameCheck  view AbstractNameCheck download AbstractNameCheck.java

java.lang.Object
  extended bycom.puppycrawl.tools.checkstyle.api.AutomaticBean
      extended bycom.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
          extended bycom.puppycrawl.tools.checkstyle.api.Check
              extended bycom.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck
                  extended bycom.puppycrawl.tools.checkstyle.checks.AbstractNameCheck
All Implemented Interfaces:
com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.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

Field Summary
 
Fields inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck
 
Fields inherited from class com.puppycrawl.tools.checkstyle.api.Check
 
Fields inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
 
Fields inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
 
Constructor Summary
AbstractNameCheck(java.lang.String aFormat)
          Creates a new AbstractNameCheck instance.
 
Method Summary
protected  boolean mustCheckName(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)
          Decides whether the name of an AST should be checked against the format regexp.
 void visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)
          Called to process a token.
 
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, 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, 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

AbstractNameCheck

public AbstractNameCheck(java.lang.String aFormat)
Creates a new AbstractNameCheck instance.

Method Detail

mustCheckName

protected boolean mustCheckName(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)
Decides whether the name of an AST should be checked against the format regexp.


visitToken

public void visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)
Description copied from class: com.puppycrawl.tools.checkstyle.api.Check
Called to process a token.