com.thomasjensen.checkstyle.addons.checks

Class AbstractAddonsCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.Check

com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck

All Implemented Interfaces:

Configurable, Contextualizable

Direct Known Subclasses:

PropertyCatalogCheck

public abstract class AbstractAddonsCheck
extends Check

Base class of all Checkstyle Addons checks.

Author:

Thomas Jensen

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAddonsCheck()

Method Summary

Methods

Modifier and Type	Method and Description
void	beginTree(DetailAST pRootAst)
void	finishTree(DetailAST pRootAst)
protected void	finishTree(String pFqcn, DetailAST pRootAst) Called after a tree is fully processed.
protected DetailAST	getClassDeclarationPosition(String pBinaryName)
protected String	getCurrentBinaryName() Gets the binary name of the class currently being traversed on the AST.
int[]	getDefaultTokens()
protected String	getMyPackage()
abstract Set<Integer>	getRelevantTokens() The tokens which this check is interested in.
int[]	getRequiredTokens()
protected boolean	isCheckStopped()
protected void	leaveKnownType(String pBinaryClassName, DetailAST pAst) Called after leaving a CLASS_DEF, INTERFACE_DEF, ANNOTATION_DEF, or ENUM_DEF token and the type's binary class name is known.
void	leaveToken(DetailAST pAst)
protected void	leaveToken(String pBinaryClassName, DetailAST pAst) Called after all the child nodes have been processed.
protected void	stopChecking()
protected void	visitKnownType(String pBinaryClassName, DetailAST pAst) Called after visiting a CLASS_DEF, INTERFACE_DEF, ANNOTATION_DEF, or ENUM_DEF token and successfully determining the type's binary class name.
void	visitToken(DetailAST pAst)
protected void	visitToken(String pBinaryClassName, DetailAST pAst) Called to process a token.

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

destroy, getAcceptableTokens, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, 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

AbstractAddonsCheck

protected AbstractAddonsCheck()

Method Detail

getDefaultTokens

public final int[] getDefaultTokens()

Specified by:

getDefaultTokens in class Check

getRelevantTokens

public abstract Set<Integer> getRelevantTokens()

The tokens which this check is interested in. Will be added to the tokens of the base class.

Returns:

the relevant tokens

getRequiredTokens

public int[] getRequiredTokens()

Overrides:

getRequiredTokens in class Check

beginTree

public void beginTree(DetailAST pRootAst)

Overrides:

beginTree in class Check

finishTree

public final void finishTree(DetailAST pRootAst)

Overrides:

finishTree in class Check

finishTree

protected void finishTree(@Nonnull
              String pFqcn,
              @Nonnull
              DetailAST pRootAst)

Called after a tree is fully processed. Ideal place to report on information collected whilst processing a tree.

Parameters:

pFqcn - the fully qualified class name of the outer class

pRootAst - the root of the tree

visitToken

protected void visitToken(@Nullable
              String pBinaryClassName,
              @Nonnull
              DetailAST pAst)

Called to process a token.

Parameters:

pBinaryClassName - the currently active binary class name

pAst - the token to process

leaveToken

protected void leaveToken(@Nullable
              String pBinaryClassName,
              @Nonnull
              DetailAST pAst)

Called after all the child nodes have been processed.

Parameters:

pBinaryClassName - the currently active binary class name

pAst - the token being completed

visitKnownType

protected void visitKnownType(@Nonnull
                  String pBinaryClassName,
                  @Nonnull
                  DetailAST pAst)

Called after visiting a CLASS_DEF, INTERFACE_DEF, ANNOTATION_DEF, or ENUM_DEF token and successfully determining the type's binary class name. This is useful in a Java source file with nested inner classes. If the implementing check registers for any of the above tokens, the regular call to visitToken(String, DetailAST) will be performed in addition to (after) this one.

Parameters:

pBinaryClassName - the binary class name of the visited type

pAst - the token to process

leaveKnownType

protected void leaveKnownType(@Nonnull
                  String pBinaryClassName,
                  @Nonnull
                  DetailAST pAst)

Called after leaving a CLASS_DEF, INTERFACE_DEF, ANNOTATION_DEF, or ENUM_DEF token and the type's binary class name is known. This is useful in a Java source file with nested inner classes. If the implementing check registers for any of the above tokens, the regular call to leaveToken(String, DetailAST) will be performed in addition to (before) this one.

Parameters:

pBinaryClassName - the binary class name of the visited type

pAst - the token being completed

visitToken

public final void visitToken(DetailAST pAst)

Overrides:

visitToken in class Check

getClassDeclarationPosition

@CheckForNull
protected DetailAST getClassDeclarationPosition(@Nonnull
                                                 String pBinaryName)

leaveToken

public final void leaveToken(DetailAST pAst)

Overrides:

leaveToken in class Check

getCurrentBinaryName

@CheckForNull
protected String getCurrentBinaryName()

Gets the binary name of the class currently being traversed on the AST. Normally, this is the single class in the .java file, but it could also be a (nested) named inner class. Whenever a new CLASS_DEF or similar token is visited, the result of this method would change.

Returns:

current binary name, or null if no CLASS_DEF or similar token has been encountered yet (e.g. while we are still going through the import statements)

getMyPackage

protected String getMyPackage()

isCheckStopped

protected boolean isCheckStopped()

stopChecking

protected void stopChecking()