Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> puppycrawl >> tools >> checkstyle >> checks >> [ usage overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.puppycrawl.tools.checkstyle.checks.usage
Class UnusedLocalVariableCheck  

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.usage.AbstractUsageCheck
                  com.puppycrawl.tools.checkstyle.checks.usage.UnusedLocalVariableCheck

All Implemented Interfaces:

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

---

public class UnusedLocalVariableCheck

extends AbstractUsageCheck

Checks that a local variable is read.

An example of how to configure the check is:

 <module name="usage.UnusedLocalVariable"/>
 

---

Field Summary

 

Fields inherited from class com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck

 

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

UnusedLocalVariableCheck()

 

Method Summary
int[]	getDefaultTokens()           Returns the default token a check is interested in.
java.lang.String	getErrorKey()           Returns the key for the Checkstyle error message.
boolean	mustCheckReferenceCount(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)           Determines whether the reference count of an aAST is required.

 

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck

applyTo, beginTree, finishTree, getASTManager, getIgnoreFormat, getRegexp, logError, setIgnoreFormat, visitToken

 

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

destroy, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, 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

 

Constructor Detail

UnusedLocalVariableCheck

public UnusedLocalVariableCheck()

Method Detail

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: com.puppycrawl.tools.checkstyle.api.Check

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

---

getErrorKey

public java.lang.String getErrorKey()

Description copied from class: AbstractUsageCheck

Returns the key for the Checkstyle error message.

Specified by:

getErrorKey in class AbstractUsageCheck

---

mustCheckReferenceCount

public boolean mustCheckReferenceCount(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)

Description copied from class: AbstractUsageCheck

Determines whether the reference count of an aAST is required.

Specified by:

mustCheckReferenceCount in class AbstractUsageCheck

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> puppycrawl >> tools >> checkstyle >> checks >> [ usage overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---