|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.Check
com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
public class HiddenFieldCheck
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>
An example of how to configure the check so that it ignores the parameter of a setter method is:
<module name="HiddenField"> <property name="ignoreSetter" value="true"/> </module>
An example of how to configure the check so that it ignores constructor parameters is:
<module name="HiddenField"> <property name="ignoreConstructorParameter" value="true"/> </module>
Constructor Summary | |
---|---|
HiddenFieldCheck()
|
Method Summary | |
---|---|
void |
beginTree(DetailAST aRootAST)
Called before the starting to process a tree. |
int[] |
getAcceptableTokens()
The configurable token set. |
int[] |
getDefaultTokens()
Returns the default token a check is interested in. |
Pattern |
getRegexp()
|
int[] |
getRequiredTokens()
The tokens that this check must be registered for. |
void |
leaveToken(DetailAST aAST)
Called after all the child nodes have been process. |
void |
setIgnoreAbstractMethods(boolean aIgnoreAbstractMethods)
Set whether to ignore parameters of abstract methods. |
void |
setIgnoreConstructorParameter(boolean aIgnoreConstructorParameter)
Set whether to ignore constructor parameters. |
void |
setIgnoreFormat(String aFormat)
Set the ignore format to the specified regular expression. |
void |
setIgnoreSetter(boolean aIgnoreSetter)
Set whether to ignore the parameter of a property setter method. |
void |
visitToken(DetailAST aAST)
Called to process a token. |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check |
---|
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 |
---|
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, 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 HiddenFieldCheck()
Method Detail |
---|
public int[] getDefaultTokens()
Check
getDefaultTokens
in class Check
TokenTypes
public int[] getAcceptableTokens()
Check
getAcceptableTokens
in class Check
TokenTypes
public int[] getRequiredTokens()
Check
getRequiredTokens
in class Check
TokenTypes
public void beginTree(DetailAST aRootAST)
Check
beginTree
in class Check
aRootAST
- the root of the treepublic void visitToken(DetailAST aAST)
Check
visitToken
in class Check
aAST
- the token to processpublic void leaveToken(DetailAST aAST)
Check
leaveToken
in class Check
aAST
- the token leavingpublic void setIgnoreFormat(String aFormat) throws ConversionException
aFormat
- a String
value
ConversionException
- unable to parse aFormatpublic void setIgnoreSetter(boolean aIgnoreSetter)
aIgnoreSetter
- decide whether to ignore the parameter of
a property setter method.public void setIgnoreConstructorParameter(boolean aIgnoreConstructorParameter)
aIgnoreConstructorParameter
- decide whether to ignore
constructor parameters.public void setIgnoreAbstractMethods(boolean aIgnoreAbstractMethods)
aIgnoreAbstractMethods
- decide whether to ignore
parameters of abstract methods.public Pattern getRegexp()
|
Back to the Checkstyle Home Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |