specification.html

<!DOCTYPE html>
<!--
 | Generated by Apache Maven Doxia Site Renderer 1.8 from src/site/xhtml/specification.xhtml at 2019-08-07
 | Rendered using Apache Maven Fluido Skin 1.7
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <meta name="Date-Revision-yyyymmdd" content="20190807" />
    <meta http-equiv="Content-Language" content="en" />
    <title>JavaNCSS &#x2013; JavaNCSS - Specification</title>
    <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
    <link rel="stylesheet" href="./css/site.css" />
    <link rel="stylesheet" href="./css/print.css" media="print" />
    <script type="text/javascript" src="./js/apache-maven-fluido-1.7.min.js"></script>
<link rel="SHORTCUT ICON" href="favjavancss.ico" />  </head>
  <body class="topBarDisabled">
    <div class="container-fluid">
      <div id="banner">
        <div class="pull-left"><a href="http://javancss.github.io/" id="bannerLeft"><h2>JavaNCSS</h2>
</a></div>
        <div class="pull-right"></div>
        <div class="clear"><hr/></div>
      </div>

      <div id="breadcrumbs">
        <ul class="breadcrumb">
      <li class=""><a href="http://www.kclee.de/clemens/java/" class="externalLink" title="Chr. Clemens Lee">Chr. Clemens Lee</a><span class="divider">/</span></li>
      <li class=""><a href="http://javancss.github.io/" class="externalLink" title="JavaNCSS">JavaNCSS</a><span class="divider">/</span></li>
    <li class="active ">JavaNCSS - Specification</li>
        <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2019-08-07</li>
          <li id="projectVersion" class="pull-right"><span class="divider">|</span>Version: 34.55-SNAPSHOT</li>
      <li class="pull-right"><span class="divider">|</span>
<a href="http://ant.apache.org/" class="externalLink" title="Ant">Ant</a></li>
      <li class="pull-right"><span class="divider">|</span>
<a href="http://maven.apache.org/" class="externalLink" title="Maven">Maven</a></li>
      <li class="pull-right"><a href="http://www.mojohaus.org/javancss-maven-plugin/" class="externalLink" title="JavaNCSS Maven Plugin">JavaNCSS Maven Plugin</a></li>
        </ul>
      </div>
      <div class="row-fluid">
        <div id="leftColumn" class="span2">
          <div class="well sidebar-nav">
    <ul class="nav nav-list">
      <li class="nav-header">General Information</li>
    <li><a href="index.html" title="Home"><span class="none"></span>Home</a></li>
    <li><a href="usage.html" title="Usage"><span class="none"></span>Usage</a></li>
    <li class="active"><a href="#"><span class="none"></span>Specification</a></li>
    <li><a href="release-history.html" title="Release History"><span class="none"></span>Release History</a></li>
    <li><a href="credits.html" title="Credits"><span class="none"></span>Credits</a></li>
    <li><a href="links.html" title="Related Links"><span class="none"></span>Related Links</a></li>
      <li class="nav-header">Development</li>
    <li><a href="development.html" title="Development"><span class="none"></span>Development</a></li>
    <li><a href="todo.html" title="TODO"><span class="none"></span>TODO</a></li>
      <li class="nav-header">Project Documentation</li>
    <li><a href="project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a></li>
    <li><a href="project-reports.html" title="Project Reports"><span class="icon-chevron-right"></span>Project Reports</a></li>
</ul>
          <hr />
          <div id="poweredBy">
            <div class="clear"></div>
            <div class="clear"></div>
            <div class="clear"></div>
            <div class="clear"></div>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
            </div>
          </div>
        </div>
        <div id="bodyColumn"  class="span10" >


<table border="0" class="table table-striped">

<tr class="a">

<td>
<center>
<h1>JavaNCSS - Specification</h1></center>
</td>
</tr>
</table>


<div class="section">
<h2><a name="Specification"></a><a name="specification"></a>Specification</h2>


<div class="section">
<h3><a name="Non_Commenting_Source_Statements_.28NCSS.29"></a>Non Commenting Source Statements (NCSS)</h3>
Statements for JavaNCSS are not statements as specified in the Java Language
Specification but include all kinds of declarations too.
<br />Roughly spoken, NCSS is approximately equivalent to counting ';' and
'{' characters in Java source files.


<p>Actually, the NCSS counter gets incremented by one for each:
<br />&#160;
<br />&#160;</p>

<center>
<table border="0" class="table table-striped">

<tr class="a">

<th></th>

<th>Examples</th>

<th>Comment</th>
</tr>


<tr class="b">

<td>Package declaration</td>


<td><tt>package java.lang;</tt></td>


<td></td>
</tr>


<tr class="a">

<td>Import declaration</td>


<td><tt>import java.awt.*;</tt></td>


<td></td>
</tr>


<tr class="b">

<td valign="top">Class declaration</td>


<td>- <tt>public class Foo {</tt>
<br />- <tt>public class Foo extends Bla {</tt></td>


<td></td>
</tr>


<tr class="a">

<td valign="top">Interface declaration</td>


<td><tt>public interface Able {</tt></td>


<td></td>
</tr>


<tr class="b">

<td valign="top">Field declaration</td>


<td valign="top">- <tt>int a;</tt>
<br />- <tt>int a, b, c = 5, d = 6;</tt></td>


<td>No matter how many fields get actually declared through a comma separated
list, and no matter if these fields get actually initialized, only
one statement is counted. So &quot;int a, b, c = 5, d = 6;&quot; gets only +1 count,
not four or even six (let me know if there is good reason to count it differently).</td>
</tr>


<tr class="a">

<td valign="top">Method declaration</td>


<td>- <tt>public void cry();</tt>
<br />- <tt>public void gib() throws DeadException {</tt></td>


<td></td>
</tr>


<tr class="b">

<td>Constructor&#160;declaration</td>


<td valign="top"><tt>public Foo() {</tt></td>


<td></td>
</tr>


<tr class="a">

<td valign="top">Constructor invocation</td>


<td>- <tt>this();</tt>
<br />- <tt>super();</tt></td>


<td></td>
</tr>


<tr class="b">

<td valign="top">Statement</td>


<td>- <tt>i = 0;</tt>
<br />- <tt>if (ok)</tt>
<br />- <tt>if (exit) {</tt>
<br />- <tt>if (3 == 4);</tt>
<br />- <tt>if (4 == 4) { ; }</tt>
<br />- <tt>} else {</tt></td>


<td valign="top">expression, if, else, while, do, for, switch, break,
continue, return, throw, synchronized, catch, finally</td>
</tr>


<tr class="a">

<td>Label</td>


<td><tt>fine :</tt></td>


<td>normal, case, default</td>
</tr>
</table></center>
&#160;<br />
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.


<p>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.</p>

</div>
<div class="section">
<h3><a name="Cyclomatic_Complexity_Number_.28CCN.29"></a>Cyclomatic Complexity Number (CCN)</h3>
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 &quot;CCN counter&quot; gets incremented by one.


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

<ul>

<li><tt>if</tt></li>

<li><tt>for</tt></li>

<li><tt>while</tt></li>

<li><tt>case</tt></li>

<li><tt>catch</tt></li>

<li><tt>&amp;&amp;</tt></li>

<li><tt>||</tt></li>

<li><tt>?</tt></li>
</ul>

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

</div></div>

        </div>
      </div>
    </div>
    <hr/>
    <footer>
      <div class="container-fluid">
        <div class="row-fluid">
            <p>Copyright &copy;1997&#x2013;2019
Chr. Clemens Lee and companions.
All rights reserved.</p>
        </div>
      </div>
    </footer>
  </body>
</html>