com.puppycrawl.tools.checkstyle.checks

Class AbstractDeclarationCollector

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.puppycrawl.tools.checkstyle.checks.AbstractDeclarationCollector

All Implemented Interfaces:

Configurable, Contextualizable

Deprecated.

Checkstyle will not support abstract checks anymore. Use AbstractCheck instead.

@Deprecated
public abstract class AbstractDeclarationCollector
extends AbstractCheck

Abstract class for checks which need to collect information about declared members/parameters/variables.

Author:

o_sukhodolsky

Constructor Summary

Constructors

Constructor and Description
AbstractDeclarationCollector() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	beginTree(DetailAST rootAST) Deprecated. Called before the starting to process a tree.
protected boolean	isClassField(String name) Deprecated. Check if given name is a name for class field in current environment.
protected boolean	isClassMethod(String name) Deprecated. Check if given name is a name for class method in current environment.
void	visitToken(DetailAST ast) Deprecated. Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck

destroy, finishTree, getAcceptableTokens, getClassLoader, getDefaultTokens, getFileContents, getLine, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, 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

AbstractDeclarationCollector

public AbstractDeclarationCollector()

Deprecated.

Method Detail

beginTree

public void beginTree(DetailAST rootAST)

Deprecated.

Description copied from class: AbstractCheck

Called before the starting to process a tree. Ideal place to initialize information that is to be collected whilst processing a tree.

Overrides:

beginTree in class AbstractCheck

Parameters:

rootAST - the root of the tree

visitToken

public void visitToken(DetailAST ast)

Deprecated.

Description copied from class: AbstractCheck

Called to process a token.

Overrides:

visitToken in class AbstractCheck

Parameters:

ast - the token to process

isClassField

protected final boolean isClassField(String name)

Deprecated.

Check if given name is a name for class field in current environment.

Parameters:

name - a name to check

Returns:

true is the given name is name of member.

isClassMethod

protected final boolean isClassMethod(String name)

Deprecated.

Check if given name is a name for class method in current environment.

Parameters:

name - a name to check

Returns:

true is the given name is name of method.