HiddenFieldCheck

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> puppycrawl >> tools >> checkstyle >> [ checks overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.puppycrawl.tools.checkstyle.checks.HiddenFieldCheck

SOURCE |

Download com.puppycrawl.tools.checkstyle.checks.HiddenFieldCheck

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.puppycrawl.tools.checkstyle.checks
Class HiddenFieldCheck

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

All Implemented Interfaces:: com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

public class HiddenFieldCheck
extends com.puppycrawl.tools.checkstyle.api.Check

Checks that a local variable or a parameter does not shadow a field that is defined in the same class.

An example of how to configure the check is:

 <module name="HiddenField"/>

An example of how to configure the check so that it checks variables but not parameters is:

 <module name="HiddenField">
    <property name="tokens" value="VARIABLE_DEF"/>
 </module>

Version:: 1.0

Field Summary

private java.util.LinkedList mFieldsStack
          stack of sets of field names, one for each class of a set of nested classes

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

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

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

Constructor Summary

HiddenFieldCheck()


Method Summary

void beginTree()


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 leaveToken(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)
          Called after all the child nodes have been process.

private void processVariable(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)
          Process a variable token.

void visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)
          Called to process a token.

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

beginTree, destroy, finishTree, getClassLoader, getFileContents, getLines, getTabWidth, getTokenNames, init, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

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

getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, 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

mFieldsStack

private java.util.LinkedList mFieldsStack

stack of sets of field names, one for each class of a set of nested classes

Constructor Detail

HiddenFieldCheck

public HiddenFieldCheck()

Method Detail