com.puppycrawl.tools.checkstyle.checks
Class DescendantTokenCheck
- Configurable, Contextualizable
public class DescendantTokenCheck
Checks for restricted tokens beneath other tokens.
Examples of how to configure the check:
<!-- String literal equality check -->
<module name="DescendantToken">
<property name="tokens" value="EQUAL,NOT_EQUAL"/>
<property name="limitedTokens" value="STRING_LITERAL"/>
<property name="maximumNumber" value="0"/>
<property name="maximumDepth" value="1"/>
</module>
<!-- Switch with no default -->
<module name="DescendantToken">
<property name="tokens" value="LITERAL_SWITCH"/>
<property name="maximumDepth" value="2"/>
<property name="limitedTokens" value="LITERAL_DEFAULT"/>
<property name="minimumNumber" value="1"/>
</module>
<!-- Assert statement may have side effects -->
<module name="DescendantToken">
<property name="tokens" value="LITERAL_ASSERT"/>
<property name="limitedTokens" value="ASSIGN,DEC,INC,POST_DEC,
POST_INC,PLUS_ASSIGN,MINUS_ASSIGN,STAR_ASSIGN,DIV_ASSIGN,MOD_ASSIGN,
BSR_ASSIGN,SR_ASSIGN,SL_ASSIGN,BAND_ASSIGN,BXOR_ASSIGN,BOR_ASSIGN,
METHOD_CALL"/>
<property name="maximumNumber" value="0"/>
</module>
<!-- Initialiser in for performs no setup - use while instead? -->
<module name="DescendantToken">
<property name="tokens" value="FOR_INIT"/>
<property name="limitedTokens" value="EXPR"/>
<property name="minimumNumber" value="1"/>
</module>
<!-- Condition in for performs no check -->
<module name="DescendantToken">
<property name="tokens" value="FOR_CONDITION"/>
<property name="limitedTokens" value="EXPR"/>
<property name="minimumNumber" value="1"/>
</module>
<!-- Switch within switch -->
<module name="DescendantToken">
<property name="tokens" value="LITERAL_SWITCH"/>
<property name="limitedTokens" value="LITERAL_SWITCH"/>
<property name="maximumNumber" value="0"/>
<property name="minimumDepth" value="1"/>
</module>
<!-- Return from within a catch or finally block -->
<module name="DescendantToken">
<property name="tokens" value="LITERAL_FINALLY,LITERAL_CATCH"/>
<property name="limitedTokens" value="LITERAL_RETURN"/>
<property name="maximumNumber" value="0"/>
</module>
<!-- Try within catch or finally block -->
<module name="DescendantToken">
<property name="tokens" value="LITERAL_CATCH,LITERAL_FINALLY"/>
<property name="limitedTokens" value="LITERAL_TRY"/>
<property name="maximumNumber" value="0"/>
</module>
<!-- Too many cases within a switch -->
<module name="DescendantToken">
<property name="tokens" value="LITERAL_SWITCH"/>
<property name="limitedTokens" value="LITERAL_CASE"/>
<property name="maximumDepth" value="2"/>
<property name="maximumNumber" value="10"/>
</module>
<!-- Too many local variables within a method -->
<module name="DescendantToken">
<property name="tokens" value="METHOD_DEF"/>
<property name="limitedTokens" value="VARIABLE_DEF"/>
<property name="maximumDepth" value="2"/>
<property name="maximumNumber" value="10"/>
</module>
<!-- Too many returns from within a method -->
<module name="DescendantToken">
<property name="tokens" value="METHOD_DEF"/>
<property name="limitedTokens" value="LITERAL_RETURN"/>
<property name="maximumNumber" value="3"/>
</module>
<!-- Too many fields within an interface -->
<module name="DescendantToken">
<property name="tokens" value="INTERFACE_DEF"/>
<property name="limitedTokens" value="VARIABLE_DEF"/>
<property name="maximumDepth" value="2"/>
<property name="maximumNumber" value="0"/>
</module>
<!-- Limit the number of exceptions a method can throw -->
<module name="DescendantToken">
<property name="tokens" value="LITERAL_THROWS"/>
<property name="limitedTokens" value="IDENT"/>
<property name="maximumNumber" value="1"/>
</module>
<!-- Limit the number of expressions in a method -->
<module name="DescendantToken">
<property name="tokens" value="METHOD_DEF"/>
<property name="limitedTokens" value="EXPR"/>
<property name="maximumNumber" value="200"/>
</module>
<!-- Disallow empty statements -->
<module name="DescendantToken">
<property name="tokens" value="EMPTY_STAT"/>
<property name="limitedTokens" value="EMPTY_STAT"/>
<property name="maximumNumber" value="0"/>
<property name="maximumDepth" value="0"/>
<property name="maximumMessage"
value="Empty statement is not allowed."/>
</module>
<!-- Too many fields within a class -->
<module name="DescendantToken">
<property name="tokens" value="CLASS_DEF"/>
<property name="limitedTokens" value="VARIABLE_DEF"/>
<property name="maximumDepth" value="2"/>
<property name="maximumNumber" value="10"/>
</module>
- Tim Tyler <tim@tt1.org>
- Rick Giles
beginTree , destroy , finishTree , getAcceptableTokens , getClassLoader , getDefaultTokens , getFileContents , getLines , getRequiredTokens , getTabWidth , getTokenNames , init , leaveToken , log , log , setClassLoader , setFileContents , setMessages , setTabWidth , setTokens , visitToken |
getMessageBundle , getSeverity , getSeverityLevel , log , log , log , log , log , log , log , log , log , log , log , setSeverity |
getAcceptableTokens
public int[] getAcceptableTokens()
- getAcceptableTokens in interface Check
Check
setLimitedTokens
public void setLimitedTokens(String[] aLimitedTokens)
Sets the tokens which occurance as descendant is limited.
aLimitedTokens
- - list of tokens to ignore.
setMaximumDepth
public void setMaximumDepth(int aMaximumDepth)
Sets the maximum depth for descendant counts.
aMaximumDepth
- the maximum depth for descendant counts.
setMaximumMessage
public void setMaximumMessage(String aMessage)
Sets the error message for maximum count exceeded.
aMessage
- the error message for maximum count exceeded.
Used as a MessageFormat
pattern with arguments
- {0} - token count
- {1} - maximum number
- {2} - name of token
- {3} - name of limited token
setMaximumNumber
public void setMaximumNumber(int aMaximumNumber)
Sets a maximum count for descendants.
aMaximumNumber
- the maximum count for descendants.
setMinimumDepth
public void setMinimumDepth(int aMinimumDepth)
Sets the mimimum depth for descendant counts.
aMinimumDepth
- the mimimum depth for descendant counts.
setMinimumMessage
public void setMinimumMessage(String aMessage)
Sets the error message for minimum count not reached.
aMessage
- the error message for minimum count not reached.
Used as a MessageFormat
pattern with arguments
- {0} - token count
- {1} - minimum number
- {2} - name of token
- {3} - name of limited token
setMinimumNumber
public void setMinimumNumber(int aMinimumNumber)
Sets a minimum count for descendants.
aMinimumNumber
- the minimum count for descendants.