Class JavaNCSSCheck
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.api.AutomaticBean
-
- com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
- com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
- com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class JavaNCSSCheck extends AbstractCheck
This check calculates the Non Commenting Source Statements (NCSS) metric for java source files and methods. The check adheres to the JavaNCSS specification and gives the same results as the JavaNCSS tool.The NCSS-metric tries to determine complexity of methods, classes and files by counting the non commenting lines. Roughly said this is (nearly) equivalent to counting the semicolons and opening curly braces.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
JavaNCSSCheck.Counter
Class representing a counter.
-
Field Summary
Fields Modifier and Type Field Description private static int
CLASS_MAX_NCSS
Default constant for max file ncss.private int
classMaximum
Maximum ncss for a class.private java.util.Deque<JavaNCSSCheck.Counter>
counters
List containing the stacked counters.private static int
FILE_MAX_NCSS
Default constant for max file ncss.private int
fileMaximum
Maximum ncss for a complete source file.private static int
METHOD_MAX_NCSS
Default constant for max method ncss.private int
methodMaximum
Maximum ncss for a method.static java.lang.String
MSG_CLASS
A key is pointing to the warning message text in "messages.properties" file.static java.lang.String
MSG_FILE
A key is pointing to the warning message text in "messages.properties" file.static java.lang.String
MSG_METHOD
A key is pointing to the warning message text in "messages.properties" file.
-
Constructor Summary
Constructors Constructor Description JavaNCSSCheck()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
beginTree(DetailAST rootAST)
Called before the starting to process a tree.void
finishTree(DetailAST rootAST)
Called after finished processing a tree.int[]
getAcceptableTokens()
The configurable token set.int[]
getDefaultTokens()
Returns the default token a check is interested in.int[]
getRequiredTokens()
The tokens that this check must be registered for.private static boolean
isCountable(DetailAST ast)
Checks if a token is countable for the ncss metric.private static boolean
isExpressionCountable(DetailAST ast)
Checks if an expression is countable for the ncss metric.private static boolean
isVariableDefCountable(DetailAST ast)
Checks if a variable definition is countable.void
leaveToken(DetailAST ast)
Called after all the child nodes have been process.void
setClassMaximum(int classMaximum)
Sets the maximum ncss for a class.void
setFileMaximum(int fileMaximum)
Sets the maximum ncss for a file.void
setMethodMaximum(int methodMaximum)
Sets the maximum ncss for a method.void
visitToken(DetailAST ast)
Called to process a token.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
destroy, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, 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
-
-
-
-
Field Detail
-
MSG_METHOD
public static final java.lang.String MSG_METHOD
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_CLASS
public static final java.lang.String MSG_CLASS
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_FILE
public static final java.lang.String MSG_FILE
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
FILE_MAX_NCSS
private static final int FILE_MAX_NCSS
Default constant for max file ncss.- See Also:
- Constant Field Values
-
CLASS_MAX_NCSS
private static final int CLASS_MAX_NCSS
Default constant for max file ncss.- See Also:
- Constant Field Values
-
METHOD_MAX_NCSS
private static final int METHOD_MAX_NCSS
Default constant for max method ncss.- See Also:
- Constant Field Values
-
fileMaximum
private int fileMaximum
Maximum ncss for a complete source file.
-
classMaximum
private int classMaximum
Maximum ncss for a class.
-
methodMaximum
private int methodMaximum
Maximum ncss for a method.
-
counters
private java.util.Deque<JavaNCSSCheck.Counter> counters
List containing the stacked counters.
-
-
Method Detail
-
getDefaultTokens
public int[] getDefaultTokens()
Description copied from class:AbstractCheck
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 classAbstractCheck
- Returns:
- the default tokens
- See Also:
TokenTypes
-
getRequiredTokens
public int[] getRequiredTokens()
Description copied from class:AbstractCheck
The tokens that this check must be registered for.- Specified by:
getRequiredTokens
in classAbstractCheck
- Returns:
- the token set this must be registered for.
- See Also:
TokenTypes
-
getAcceptableTokens
public int[] getAcceptableTokens()
Description copied from class:AbstractCheck
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.- Specified by:
getAcceptableTokens
in classAbstractCheck
- Returns:
- the token set this check is designed for.
- See Also:
TokenTypes
-
beginTree
public void beginTree(DetailAST rootAST)
Description copied from class:AbstractCheck
Called before the starting to process a tree. Ideal place to initialize information that is to be collected whilst processing a tree.- Overrides:
beginTree
in classAbstractCheck
- Parameters:
rootAST
- the root of the tree
-
visitToken
public void visitToken(DetailAST ast)
Description copied from class:AbstractCheck
Called to process a token.- Overrides:
visitToken
in classAbstractCheck
- Parameters:
ast
- the token to process
-
leaveToken
public void leaveToken(DetailAST ast)
Description copied from class:AbstractCheck
Called after all the child nodes have been process.- Overrides:
leaveToken
in classAbstractCheck
- Parameters:
ast
- the token leaving
-
finishTree
public void finishTree(DetailAST rootAST)
Description copied from class:AbstractCheck
Called after finished processing a tree. Ideal place to report on information collected whilst processing a tree.- Overrides:
finishTree
in classAbstractCheck
- Parameters:
rootAST
- the root of the tree
-
setFileMaximum
public void setFileMaximum(int fileMaximum)
Sets the maximum ncss for a file.- Parameters:
fileMaximum
- the maximum ncss
-
setClassMaximum
public void setClassMaximum(int classMaximum)
Sets the maximum ncss for a class.- Parameters:
classMaximum
- the maximum ncss
-
setMethodMaximum
public void setMethodMaximum(int methodMaximum)
Sets the maximum ncss for a method.- Parameters:
methodMaximum
- the maximum ncss
-
isCountable
private static boolean isCountable(DetailAST ast)
Checks if a token is countable for the ncss metric.- Parameters:
ast
- the AST- Returns:
- true if the token is countable
-
isVariableDefCountable
private static boolean isVariableDefCountable(DetailAST ast)
Checks if a variable definition is countable.- Parameters:
ast
- the AST- Returns:
- true if the variable definition is countable, false otherwise
-
isExpressionCountable
private static boolean isExpressionCountable(DetailAST ast)
Checks if an expression is countable for the ncss metric.- Parameters:
ast
- the AST- Returns:
- true if the expression is countable, false otherwise
-
-