|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
Checks that a parameter is used.
An example of how to configure the check is:
<module name="usage.UnusedParameter"/>
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. |
boolean |
mustCheckReferenceCount(DetailAST aAST)
Determines whether the reference count of an aAST is required. |
void |
setIgnoreCatch(boolean aIgnoreCatch)
Control whether unused catch clause parameters are flagged. |
void |
setIgnoreNonLocal(boolean aIgnoreNonLocal)
Controls whether public/protected/paskage methods shouldn't be checked. |
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, 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 |
public UnusedParameterCheck()
Method Detail |
public int[] getDefaultTokens()
Check
getDefaultTokens
in class Check
Check
public java.lang.String getErrorKey()
AbstractUsageCheck
getErrorKey
in class AbstractUsageCheck
AbstractUsageCheck
public boolean mustCheckReferenceCount(DetailAST aAST)
AbstractUsageCheck
mustCheckReferenceCount
in class AbstractUsageCheck
aAST
- the node to check.
AbstractUsageCheck
public void setIgnoreCatch(boolean aIgnoreCatch)
aIgnoreCatch
- whether unused catch clause parameters
should be flagged.public void setIgnoreNonLocal(boolean aIgnoreNonLocal)
aIgnoreNonLocal
- whether we should check any other methods
except static and private should be checked.
|
Back to the Checkstyle Home Page | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |