com.thomasjensen.checkstyle.addons.checks

Class AbstractMethodCallCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck

com.thomasjensen.checkstyle.addons.checks.AbstractMethodCallCheck

All Implemented Interfaces:

com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

Direct Known Subclasses:

IllegalMethodCallCheck, LocationReferenceCheck

public abstract class AbstractMethodCallCheck
extends AbstractAddonsCheck

Checks deriving from this type are aware of method calls occurring anywhere in the source, and get explicitly notified when such calls are encountered. The full qualifier of the call is provided.

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AutomaticBean.OutputStreamOptions

Constructor Summary

Constructors

Constructor and Description
AbstractMethodCallCheck()

Method Summary

Modifier and Type	Method and Description
void	beginTree(com.puppycrawl.tools.checkstyle.api.DetailAST pRootAst)
java.lang.String	getCurrentMethodName() The current method name.
java.util.Set<java.lang.Integer>	getRelevantTokens() The tokens which this check is interested in.
protected abstract boolean	isCheckActive() Determines if the check is configured to do anything at all.
protected abstract boolean	isRelevantCall(java.lang.String pQualifier, java.lang.String pMethodName) Filter method which determines if the given method call is considered relevant.
protected void	leaveToken(BinaryName pBinaryClassName, com.puppycrawl.tools.checkstyle.api.DetailAST pAst) Called after all the child nodes have been processed.
protected abstract void	visitMethodCall(java.lang.String pMethodName, com.puppycrawl.tools.checkstyle.api.DetailAST pMethodCallAst) Visitor method called when a relevant method call is encountered.
protected void	visitToken(BinaryName pBinaryClassName, com.puppycrawl.tools.checkstyle.api.DetailAST pAst) Called to process a token.

Methods inherited from class com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck

finishTree, finishTree, getAcceptableTokens, getApiFixer, getClassDeclarationPosition, getCurrentBinaryName, getCurrentSimpleName, getDefaultTokens, getMyPackage, getRequiredTokens, leaveKnownType, leaveToken, visitKnownType, visitToken

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

clearMessages, destroy, getClassLoader, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, log, log, log, setClassLoader, setFileContents, setTabWidth, setTokens

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

finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

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

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractMethodCallCheck

public AbstractMethodCallCheck()

Method Detail

beginTree

public void beginTree(com.puppycrawl.tools.checkstyle.api.DetailAST pRootAst)

Overrides:

beginTree in class AbstractAddonsCheck

getCurrentMethodName

@CheckForNull
public java.lang.String getCurrentMethodName()

The current method name. "<init>" is used for constructors and instance initializers, and "<clinit>" is used for static initializers.

Returns:

the method name, or null if we are not inside a method, constructor, or initializer

getRelevantTokens

public java.util.Set<java.lang.Integer> getRelevantTokens()

Description copied from class: AbstractAddonsCheck

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

Specified by:

getRelevantTokens in class AbstractAddonsCheck

Returns:

the relevant tokens

isCheckActive

protected abstract boolean isCheckActive()

Determines if the check is configured to do anything at all.

Returns:

true if processing should be performed

isRelevantCall

protected abstract boolean isRelevantCall(@Nullable
                                          java.lang.String pQualifier,
                                          @Nonnull
                                          java.lang.String pMethodName)

Filter method which determines if the given method call is considered relevant.

Parameters:

pQualifier - the qualifier of the method call (for a call like Foo.Bar.call(), the qualifier is Foo.Bar)

pMethodName - the simple name of the called method

Returns:

indication of whether the call is relevant (true) or not (false)

leaveToken

protected void leaveToken(@Nullable
                          BinaryName pBinaryClassName,
                          @Nonnull
                          com.puppycrawl.tools.checkstyle.api.DetailAST pAst)

Description copied from class: AbstractAddonsCheck

Called after all the child nodes have been processed.

Overrides:

leaveToken in class AbstractAddonsCheck

Parameters:

pBinaryClassName - the currently active binary class name

pAst - the token being completed

visitMethodCall

protected abstract void visitMethodCall(@Nonnull
                                        java.lang.String pMethodName,
                                        @Nonnull
                                        com.puppycrawl.tools.checkstyle.api.DetailAST pMethodCallAst)

Visitor method called when a relevant method call is encountered. This method is called in addition to the other visitor methods.

Parameters:

pMethodName - the simple name of the called method

pMethodCallAst - AST of the call, useful for logging issues ( this is a METHOD_DEF, CTOR_CALL, or a SUPER_CTOR_CALL token)

visitToken

protected void visitToken(@Nullable
                          BinaryName pBinaryClassName,
                          @Nonnull
                          com.puppycrawl.tools.checkstyle.api.DetailAST pAst)

Description copied from class: AbstractAddonsCheck

Called to process a token.

Overrides:

visitToken in class AbstractAddonsCheck

Parameters:

pBinaryClassName - the currently active binary class name

pAst - the token to process