com.puppycrawl.tools.checkstyle.checks
Class FinalParametersCheck
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.FinalParametersCheck
- All Implemented Interfaces:
- Configurable, Contextualizable
- public class FinalParametersCheck
- extends Check
Check that method/constructor/catch/foreach parameters are final.
The user can set the token set to METHOD_DEF, CONSTRUCTOR_DEF,
LITERAL_CATCH, FOR_EACH_CLAUSE or any combination of these token
types, to control the scope of this check.
Default scope is both METHOD_DEF and CONSTRUCTOR_DEF.
- Author:
- lkuehne, o_sukhodolsky, Michael Studman
Method Summary |
int[] |
getAcceptableTokens()
The configurable token set.
Used to protect Checks against malicious users who specify an
unacceptable token set in the configuration file.
The default implementation returns the check's default tokens. |
int[] |
getDefaultTokens()
Returns the default token a check is interested in. Only used if the
configuration for a check does not define the tokens. |
void |
visitToken(DetailAST aAST)
Called to process a token. |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check |
beginTree, destroy, finishTree, 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 |
getId, getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, setId, setSeverity |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
FinalParametersCheck
public FinalParametersCheck()
getDefaultTokens
public int[] getDefaultTokens()
- Returns the default token a check is interested in. Only used if the
configuration for a check does not define the tokens.
- Specified by:
getDefaultTokens
in class Check
- Returns:
- the default tokens
- See Also:
TokenTypes
getAcceptableTokens
public int[] getAcceptableTokens()
- The configurable token set.
Used to protect Checks against malicious users who specify an
unacceptable token set in the configuration file.
The default implementation returns the check's default tokens.
- Overrides:
getAcceptableTokens
in class Check
- Returns:
- the token set this check is designed for.
- See Also:
TokenTypes
visitToken
public void visitToken(DetailAST aAST)
- Called to process a token.
- Overrides:
visitToken
in class Check
- Parameters:
aAST
- the token to process