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 UnusedParameterCheck  

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

All Implemented Interfaces:

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

---

public class UnusedParameterCheck

extends AbstractUsageCheck

Checks that a parameter is used.

An example of how to configure the check is:

 <module name="usage.UnusedParameter"/>
 

---

Field Summary
private  boolean	mIgnoreCatch           controls checking of catch clause parameter

 

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

UnusedParameterCheck()

 

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.
private  boolean	hasBody(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)           Determines whether an AST is a method definition with a body, or is a constructor definition.
boolean	mustCheckReferenceCount(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)           Determines whether the reference count of an aAST is required.
void	setIgnoreCatch(boolean aIgnoreCatch)           Control whether unused catch clause parameters are flagged.

 

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

 

Field Detail

mIgnoreCatch

private boolean mIgnoreCatch

controls checking of catch clause parameter

Constructor Detail

UnusedParameterCheck

public UnusedParameterCheck()

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

---

hasBody

private boolean hasBody(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)

Determines whether an AST is a method definition with a body, or is a constructor definition.

---

setIgnoreCatch

public void setIgnoreCatch(boolean aIgnoreCatch)

Control whether unused catch clause parameters are flagged.

---

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

---