com.puppycrawl.tools.checkstyle.checks

Class DeclarationCollector

Implemented Interfaces:
Configurable, Contextualizable
Known Direct Subclasses:
RequireThisCheck, UnusedImportsCheck

public abstract class DeclarationCollector
extends Check

Abstract class for chekcs which need to collect information about declared members/parameters/variables.
Author:
o_sukhodolsky

Method Summary

void
beginTree(DetailAST aRootAST)
protected boolean
isClassField(String aName)
Check if given name is a name for class field in current environment.
protected boolean
isDeclared(String aName)
Check if given name is a name for declafred variable/parameter/member in current environment.
void
leaveToken(DetailAST aAST)
void
visitToken(DetailAST aAST)

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

Method Details

beginTree

public void beginTree(DetailAST aRootAST)
Overrides:
beginTree in interface Check

isClassField

protected final boolean isClassField(String aName)
Check if given name is a name for class field in current environment.
Parameters:
aName - a name to check
Returns:
true is the given name is name of method or member.

isDeclared

protected final boolean isDeclared(String aName)
Check if given name is a name for declafred variable/parameter/member in current environment.
Parameters:
aName - a name to check
Returns:
true is the given name is declare one.

leaveToken

public void leaveToken(DetailAST aAST)
Overrides:
leaveToken in interface Check

visitToken

public void visitToken(DetailAST aAST)
Overrides:
visitToken in interface Check