com.puppycrawl.tools.checkstyle.checks.coding

Class RequireThisCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.Check

com.puppycrawl.tools.checkstyle.checks.AbstractDeclarationCollector

com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class RequireThisCheck
extends AbstractDeclarationCollector

Checks that code doesn't rely on the "this" default. That is references to instance variables and methods of the present object are explicitly of the form "this.varName" or "this.methodName(args)".

Examples of use:

 <module name="RequireThis"/>
 

An example of how to configure to check this qualifier for methods only:

 <module name="RequireThis">
   <property name="checkFields" value="false"/>
   <property name="checkMethods" value="true"/>
 </module>
 

Limitations: I'm not currently doing anything about static variables or catch-blocks. Static methods invoked on a class name seem to be OK; both the class name and the method name have a DOT parent. Non-static methods invoked on either this or a variable name seem to be OK, likewise.

Much of the code for this check was cribbed from Rick Giles's HiddenFieldCheck.

Author:

Stephen Bloch, o_sukhodolsky

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_METHOD A key is pointing to the warning message text in "messages.properties" file.
static String	MSG_VARIABLE A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor and Description
RequireThisCheck()

Method Summary

Modifier and Type	Method and Description
int[]	getAcceptableTokens() The configurable token set.
int[]	getDefaultTokens() Returns the default token a check is interested in.
int[]	getRequiredTokens() The tokens that this check must be registered for.
void	setCheckFields(boolean checkFields) Setter for checkFields property.
void	setCheckMethods(boolean checkMethods) Setter for checkMethods property.
void	visitToken(DetailAST ast) Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractDeclarationCollector

beginTree, isClassField, isClassMethod

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

destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, 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

Field Detail

MSG_METHOD

public static final String MSG_METHOD

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

MSG_VARIABLE

public static final String MSG_VARIABLE

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

Constructor Detail

RequireThisCheck

public RequireThisCheck()

Method Detail

setCheckFields

public void setCheckFields(boolean checkFields)

Setter for checkFields property.

Parameters:

checkFields - should we check fields usage or not.

setCheckMethods

public void setCheckMethods(boolean checkMethods)

Setter for checkMethods property.

Parameters:

checkMethods - should we check methods usage or not.

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: Check

Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.

Specified by:

getDefaultTokens in class Check

Returns:

the default tokens

See Also:

TokenTypes

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: Check

The tokens that this check must be registered for.

Overrides:

getRequiredTokens in class Check

Returns:

the token set this must be registered for.

See Also:

TokenTypes

getAcceptableTokens

public int[] getAcceptableTokens()

Description copied from class: Check

The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.

Overrides:

getAcceptableTokens in class Check

Returns:

the token set this check is designed for.

See Also:

TokenTypes

visitToken

public void visitToken(DetailAST ast)

Description copied from class: Check

Called to process a token.

Overrides:

visitToken in class AbstractDeclarationCollector

Parameters:

ast - the token to process