com.puppycrawl.tools.checkstyle.checks.coding
public class RequireThisCheck extends DeclarationCollector
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
.
Constructor Summary | |
---|---|
RequireThisCheck() Creates new instance of the check. |
Method Summary | |
---|---|
boolean | getCheckFields() |
boolean | getCheckMethods() |
int[] | getDefaultTokens() {@inheritDoc} |
int[] | getRequiredTokens() {@inheritDoc} |
void | setCheckFields(boolean aCheckFields)
Setter for checkFields property. |
void | setCheckMethods(boolean aCheckMethods)
Setter for checkMethods property. |
void | visitToken(DetailAST aAST) {@inheritDoc} |
Returns: true if we should check fields usage false overwise.
Returns: true if we should check methods usage false overwise.
Parameters: aCheckFields should we check fields usage or not.
Parameters: aCheckMethods should we check methods usage or not.