JavaNCSS Metric Results

[ package ] [ object ] [ method ] [ explanation ]

The following document contains the results of a JavaNCSS metric analysis.
JavaNCSS web site.

Packages

[ package ] [ object ] [ method ] [ explanation ]

Packages sorted by NCSS.

Package Classes Methods NCSS Javadocs Javadoc lines Single lines comment Multi lines comment
org.sat4j.reader 5 65 386 2 18 28 100
org.sat4j.csp 12 59 315 11 66 9 257
org.sat4j.csp.constraints 7 20 158 1 6 5 126
org.sat4j.csp.encodings 3 21 124 0 0 3 54
Classes total Methods total NCSS total Javadocs Javadoc lines Single lines comment Multi lines comment
27 165 983 14 90 45 537

Objects

[ package ] [ object ] [ method ] [ explanation ]

TOP 30 classes containing the most NCSS.

Object NCSS Methods Classes Javadocs
org.sat4j.reader.CSPReader 241 46 0 1
org.sat4j.reader.CSPInstanceReader 64 9 0 1
org.sat4j.csp.Predicate 60 6 0 1
org.sat4j.csp.constraints.Supports 57 7 0 0
org.sat4j.csp.encodings.BinarySupportEncoding 38 8 0 0
org.sat4j.csp.encodings.GeneralizedSupportEncoding 34 7 0 0
org.sat4j.csp.CSPLauncher 33 6 0 0
org.sat4j.csp.SolverFactory 30 9 0 6
org.sat4j.csp.Var 26 6 0 0
org.sat4j.csp.RangeDomain 24 5 1 0
org.sat4j.csp.SingletonDomain 23 5 1 1
org.sat4j.csp.EnumeratedDomain 22 5 1 0
org.sat4j.reader.XMLCSPReader 20 6 0 0
org.sat4j.csp.constraints.AllDiff 18 1 0 0
org.sat4j.csp.constraints.Nogoods 17 4 0 0
org.sat4j.csp.encodings.DirectEncoding 16 6 0 0
org.sat4j.csp.Constant 14 5 0 0
org.sat4j.csp.constraints.GentSupports 7 2 0 0
org.sat4j.reader.CSPSupportReader 5 2 0 0
org.sat4j.reader.CSPExtSupportReader 5 2 0 0
org.sat4j.csp.Domain 5 4 0 0
org.sat4j.csp.constraints.BessiereSupports 5 2 0 0
org.sat4j.csp.constraints.WalshSupports 5 2 0 0
org.sat4j.csp.Encoding 5 4 0 0
org.sat4j.csp.Evaluable 4 3 0 3
org.sat4j.csp.constraints.Relation 3 2 0 1
org.sat4j.csp.Clausifiable 2 1 0 0

TOP 30 classes containing the most methods.

Object NCSS Methods Classes Javadocs
org.sat4j.reader.CSPReader 241 46 0 1
org.sat4j.reader.CSPInstanceReader 64 9 0 1
org.sat4j.csp.SolverFactory 30 9 0 6
org.sat4j.csp.encodings.BinarySupportEncoding 38 8 0 0
org.sat4j.csp.encodings.GeneralizedSupportEncoding 34 7 0 0
org.sat4j.csp.constraints.Supports 57 7 0 0
org.sat4j.reader.XMLCSPReader 20 6 0 0
org.sat4j.csp.Predicate 60 6 0 1
org.sat4j.csp.encodings.DirectEncoding 16 6 0 0
org.sat4j.csp.Var 26 6 0 0
org.sat4j.csp.CSPLauncher 33 6 0 0
org.sat4j.csp.Constant 14 5 0 0
org.sat4j.csp.EnumeratedDomain 22 5 1 0
org.sat4j.csp.RangeDomain 24 5 1 0
org.sat4j.csp.SingletonDomain 23 5 1 1
org.sat4j.csp.Domain 5 4 0 0
org.sat4j.csp.constraints.Nogoods 17 4 0 0
org.sat4j.csp.Encoding 5 4 0 0
org.sat4j.csp.Evaluable 4 3 0 3
org.sat4j.reader.CSPSupportReader 5 2 0 0
org.sat4j.reader.CSPExtSupportReader 5 2 0 0
org.sat4j.csp.constraints.Relation 3 2 0 1
org.sat4j.csp.constraints.BessiereSupports 5 2 0 0
org.sat4j.csp.constraints.WalshSupports 5 2 0 0
org.sat4j.csp.constraints.GentSupports 7 2 0 0
org.sat4j.csp.Clausifiable 2 1 0 0
org.sat4j.csp.constraints.AllDiff 18 1 0 0

Averages.

NCSS average Program NCSS Classes average Methods average Javadocs average
29.00 983.00 0.11 6.11 0.52

Methods

[ package ] [ object ] [ method ] [ explanation ]

TOP 30 Methods containing the most NCSS.

Methods NCSS CCN Javadocs
org.sat4j.reader.CSPReader.readProblem(LineNumberReader) 48 9 0
org.sat4j.reader.CSPInstanceReader.parseInstance(String) 32 12 0
org.sat4j.csp.Predicate.find(Script[],int,Var,Evaluable,ISolver) 20 6 0
org.sat4j.csp.constraints.Supports.notPresent(boolean[]) 19 8 0
org.sat4j.csp.constraints.AllDiff.toClause(ISolver,Var,Evaluable) 17 6 0
org.sat4j.csp.constraints.Supports.find(Var[],int,Var,ISolver) 14 4 0
org.sat4j.csp.Predicate.toClause(ISolver,Var,Evaluable) 12 3 0
org.sat4j.csp.encodings.GeneralizedSupportEncoding.fill(int,Var,Var[],IVecInt) 12 6 0
org.sat4j.csp.encodings.BinarySupportEncoding.generateClauses(Evaluable,IVecInt,ISolver) 11 4 0
org.sat4j.csp.CSPLauncher.createReader(ISolver,String) 11 3 0
org.sat4j.reader.CSPReader.endVariablesSection() 10 4 0
org.sat4j.csp.encodings.GeneralizedSupportEncoding.onSupport(ISolver,Var,Integer) 10 4 0
org.sat4j.csp.constraints.Supports.toClause(ISolver,Var,Evaluable) 10 1 0
org.sat4j.reader.CSPReader.beginRelation(String,int,int,boolean) 9 3 0
org.sat4j.csp.EnumeratedDomain.iterator() 9 1 0
org.sat4j.csp.RangeDomain.iterator() 9 1 0
org.sat4j.csp.SingletonDomain.iterator() 9 1 0
org.sat4j.reader.CSPReader.addDomainValue(int) 8 4 0
org.sat4j.reader.CSPReader.addDomainValue(int,int) 8 4 0
org.sat4j.reader.CSPReader.constraintReference(String) 8 4 0
org.sat4j.csp.CSPLauncher.main(String[]) 8 4 0
org.sat4j.reader.XMLCSPReader.parseInstance(String) 7 5 0
org.sat4j.reader.CSPReader.beginConstraint(String,int) 7 2 0
org.sat4j.csp.encodings.DirectEncoding.onNogood(ISolver,Var,Integer) 7 2 0
org.sat4j.csp.encodings.BinarySupportEncoding.onSupport(ISolver,Var,Integer) 7 1 0
org.sat4j.csp.constraints.Nogoods.toClause(ISolver,Var,Evaluable) 7 3 0
org.sat4j.reader.CSPReader.parseInstance(LineNumberReader) 6 4 0
org.sat4j.reader.CSPReader.decode(String[]) 6 2 0
org.sat4j.reader.CSPReader.beginDomain(String,int) 6 1 0
org.sat4j.reader.CSPReader.endDomain() 6 3 0

Averages.

Program NCSS NCSS average CCN average Javadocs average
983.00 4.11 1.75 0.05

Explanations

[ package ] [ object ] [ method ] [ explanation ]

Non Commenting Source Statements (NCSS)

Statements for JavaNCSS are not statements as specified in the Java Language Specification but include all kinds of declarations too. Roughly spoken, NCSS is approximately equivalent to counting ';' and '{' characters in Java source files.

Not counted are empty statements, empty blocks or semicolons after closing brackets. Of course, comments don't get counted too. Closing brackets also never get counted, the same applies to blocks in general.

Examples
Package declaration package java.lang;
Import declaration import java.awt.*;
Class declaration
  • public class Foo {
  • public class Foo extends Bla {
Interface declaration public interface Able ; {
Field declaration
  • int a;
  • int a, b, c = 5, d = 6;
Method declaration
  • public void cry();
  • public void gib() throws DeadException {
Constructor declaration public Foo() {
Constructor invocation
  • this();
  • super();
Statement declaration
  • i = 0;
  • if (ok)
  • if (exit) {
  • if (3 == 4);
  • if (4 == 4) { ;
  • } else {
Label declaration fine :

In some cases consecutive semicolons are illegal according to the JLS but JavaNCSS still tolerates them (thought JavaNCSS is still more strict as 'javac'). Nevertheless they are never counted as two statements.

Cyclomatic Complexity Number (CCN)

CCN is also know as McCabe Metric. There exists a much hyped theory behind it based on graph theory, but it all comes down to simply counting 'if', 'for', 'while' statements etc. in a method. Whenever the control flow of a method splits, the "CCN counter" gets incremented by one.

Each method has a minimum value of 1 per default. For each of the following Java keywords/statements this value gets incremented by one:

  • if
  • for
  • while
  • case
  • catch

Also if the control flow of a method returns abortively the CCNvalue will be incremented by one:

  • if
  • for

An ordinary return at the end of method will not be counted.

Note that 'else', 'default', and 'finally' don't increment the CCN value any further. On the other hand, a simple method with a 'switch' statement and a huge block of 'case' statements can have a surprisingly high CCN value (still it has the same value when converting a 'switch' block to an equivalent sequence of 'if' statements).