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.AbstractCheck

com.puppycrawl.tools.checkstyle.api.Check

com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck

All Implemented Interfaces:

Configurable, Contextualizable

Direct Known Subclasses:

AbstractMethodCallCheck, LostInstanceCheck, PropertyCatalogCheck, RegexpOnStringCheck

public abstract class AbstractAddonsCheck
extends Check

Base class of all Checkstyle Addons checks.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAddonsCheck()
protected	AbstractAddonsCheck(String pMockfile)

Method Summary

Modifier and Type	Method and Description
void	beginTree(DetailAST pRootAst)
protected void	finishTree(BinaryName pOuterClassName, DetailAST pRootAst) Called after a tree is fully processed.
void	finishTree(DetailAST pRootAst)
protected CheckstyleApiFixer	getApiFixer()
protected DetailAST	getClassDeclarationPosition(BinaryName pBinaryName)
protected BinaryName	getCurrentBinaryName() Gets the binary name of the class currently being traversed on the AST.
protected String	getCurrentSimpleName() Gets the simple name of the current class, interface, annotation, or enum.
int[]	getDefaultTokens()
protected String	getMyPackage()
abstract Set<Integer>	getRelevantTokens() The tokens which this check is interested in.
int[]	getRequiredTokens()
protected void	leaveKnownType(BinaryName 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.
protected void	leaveToken(BinaryName pBinaryClassName, DetailAST pAst) Called after all the child nodes have been processed.
void	leaveToken(DetailAST pAst)
protected void	visitKnownType(BinaryName 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.
protected void	visitToken(BinaryName pBinaryClassName, DetailAST pAst) Called to process a token.
void	visitToken(DetailAST pAst)

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

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()

AbstractAddonsCheck

protected AbstractAddonsCheck(@Nullable
                              String pMockfile)

Method Detail

beginTree

public void beginTree(DetailAST pRootAst)

Overrides:

beginTree in class AbstractCheck

finishTree

protected void finishTree(@Nonnull
                          BinaryName pOuterClassName,
                          @Nonnull
                          DetailAST pRootAst)

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

Parameters:

pOuterClassName - the fully qualified class name of the outer class

pRootAst - the root of the tree

finishTree

public final void finishTree(DetailAST pRootAst)

Overrides:

finishTree in class AbstractCheck

getApiFixer

@Nonnull
protected CheckstyleApiFixer getApiFixer()

getClassDeclarationPosition

@CheckForNull
protected DetailAST getClassDeclarationPosition(@Nonnull
                                                               BinaryName pBinaryName)

getCurrentBinaryName

@CheckForNull
protected BinaryName 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)

getCurrentSimpleName

@CheckForNull
protected String getCurrentSimpleName()

Gets the simple name of the current class, interface, annotation, or enum.

Returns:

the simple class name, or null if we are outside of a type definition

getDefaultTokens

public final int[] getDefaultTokens()

Specified by:

getDefaultTokens in class AbstractCheck

getMyPackage

protected String getMyPackage()

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 AbstractCheck

leaveKnownType

protected void leaveKnownType(@Nonnull
                              BinaryName 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(BinaryName, 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

leaveToken

protected void leaveToken(@Nullable
                          BinaryName 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

leaveToken

public final void leaveToken(DetailAST pAst)

Overrides:

leaveToken in class AbstractCheck

visitKnownType

protected void visitKnownType(@Nonnull
                              BinaryName 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(BinaryName, 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

visitToken

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

Called to process a token.

Parameters:

pBinaryClassName - the currently active binary class name

pAst - the token to process

visitToken

public final void visitToken(DetailAST pAst)

Overrides:

visitToken in class AbstractCheck