com.thomasjensen.checkstyle.addons.checks.coding

Class IllegalMethodCallCheck

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

com.thomasjensen.checkstyle.addons.checks.coding.IllegalMethodCallCheck

All Implemented Interfaces:

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

public class IllegalMethodCallCheck
extends AbstractMethodCallCheck

Flags calls to methods with certain names. Occurrences are flagged based on the name alone; the type of the object to which the method belongs is not taken into account.

Documentation

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

Method Summary

Modifier and Type	Method and Description
protected boolean	isCheckActive() Determines if the check is configured to do anything at all.
protected boolean	isRelevantCall(java.lang.String pQualifier, java.lang.String pMethodName) Filter method which determines if the given method call is considered relevant.
void	setExcludedQualifiers(java.lang.String... pExcludedQualifiers) Setter.
void	setIllegalMethodNames(java.lang.String... pIllegalMethodNames) Setter.
protected void	visitMethodCall(java.lang.String pMethodName, com.puppycrawl.tools.checkstyle.api.DetailAST pMethodCallAst) Visitor method called when a relevant method call is encountered.

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

beginTree, getCurrentMethodName, getRelevantTokens, leaveToken, visitToken

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

IllegalMethodCallCheck

public IllegalMethodCallCheck()

Method Detail

isCheckActive

protected boolean isCheckActive()

Description copied from class: AbstractMethodCallCheck

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

Specified by:

isCheckActive in class AbstractMethodCallCheck

Returns:

true if processing should be performed

isRelevantCall

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

Description copied from class: AbstractMethodCallCheck

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

Specified by:

isRelevantCall in class AbstractMethodCallCheck

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)

setExcludedQualifiers

public void setExcludedQualifiers(java.lang.String... pExcludedQualifiers)

Setter.

Parameters:

pExcludedQualifiers - the list of excluded contexts

setIllegalMethodNames

public void setIllegalMethodNames(java.lang.String... pIllegalMethodNames)

Setter.

Parameters:

pIllegalMethodNames - the list of method names to flag

visitMethodCall

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

Description copied from class: AbstractMethodCallCheck

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

Specified by:

visitMethodCall in class AbstractMethodCallCheck

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)