|
||||||||||
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.metrics.JavaNCSSCheck
public class JavaNCSSCheck
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.
Constructor Summary | |
---|---|
JavaNCSSCheck()
|
Method Summary | |
---|---|
void |
beginTree(DetailAST aRootAST)
Called before the starting to process a tree. |
void |
finishTree(DetailAST aRootAST)
Called after finished processing a tree. |
int[] |
getDefaultTokens()
Returns the default token a check is interested in. |
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 |
setClassMaximum(int aClassMax)
Sets the maximum ncss for a class. |
void |
setFileMaximum(int aFileMax)
Sets the maximum ncss for a file. |
void |
setMethodMaximum(int aMethodMax)
Sets the maximum ncss for a method. |
void |
visitToken(DetailAST aAST)
Called to process a token. |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check |
---|
destroy, getAcceptableTokens, getClassLoader, getFileContents, getLines, getTabWidth, getTokenNames, init, 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 JavaNCSSCheck()
Method Detail |
---|
public int[] getDefaultTokens()
getDefaultTokens
in class Check
TokenTypes
public int[] getRequiredTokens()
getRequiredTokens
in class Check
TokenTypes
public void beginTree(DetailAST aRootAST)
beginTree
in class Check
aRootAST
- the root of the treepublic void visitToken(DetailAST aAST)
visitToken
in class Check
aAST
- the token to processpublic void leaveToken(DetailAST aAST)
leaveToken
in class Check
aAST
- the token leavingpublic void finishTree(DetailAST aRootAST)
finishTree
in class Check
aRootAST
- the root of the treepublic void setFileMaximum(int aFileMax)
aFileMax
- the maximum ncsspublic void setClassMaximum(int aClassMax)
aClassMax
- the maximum ncsspublic void setMethodMaximum(int aMethodMax)
aMethodMax
- the maximum ncss
|
Back to the Checkstyle Home Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |