com.puppycrawl.tools.checkstyle.checks.metrics

Class JavaNCSSCheck

public class JavaNCSSCheck extends Check

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.

Author: Lars Ködderitzsch

Method Summary
voidbeginTree(DetailAST aRootAST)
{@inheritDoc}
voidfinishTree(DetailAST aRootAST)
{@inheritDoc}
int[]getDefaultTokens()
{@inheritDoc}
int[]getRequiredTokens()
{@inheritDoc}
voidleaveToken(DetailAST aAST)
{@inheritDoc}
voidsetClassMaximum(int aClassMax)
Sets the maximum ncss for a class.
voidsetFileMaximum(int aFileMax)
Sets the maximum ncss for a file.
voidsetMethodMaximum(int aMethodMax)
Sets the maximum ncss for a method.
voidvisitToken(DetailAST aAST)
{@inheritDoc}

Method Detail

beginTree

public void beginTree(DetailAST aRootAST)
{@inheritDoc}

finishTree

public void finishTree(DetailAST aRootAST)
{@inheritDoc}

getDefaultTokens

public int[] getDefaultTokens()
{@inheritDoc}

getRequiredTokens

public int[] getRequiredTokens()
{@inheritDoc}

leaveToken

public void leaveToken(DetailAST aAST)
{@inheritDoc}

setClassMaximum

public void setClassMaximum(int aClassMax)
Sets the maximum ncss for a class.

Parameters: aClassMax the maximum ncss

setFileMaximum

public void setFileMaximum(int aFileMax)
Sets the maximum ncss for a file.

Parameters: aFileMax the maximum ncss

setMethodMaximum

public void setMethodMaximum(int aMethodMax)
Sets the maximum ncss for a method.

Parameters: aMethodMax the maximum ncss

visitToken

public void visitToken(DetailAST aAST)
{@inheritDoc}