Maven Author Plugin
[ packages] [ objects][ functions][ explanations]
The following document contains the results of a JavaNCSSmetric analysis.
[ packages] [ objects][ functions][ explanations]
| Package | Classes | Functions | NCSS | Javadocs | Javadoc Lines | Single Comment Lines | Multi Comment Lines |
|---|---|---|---|---|---|---|---|
| org.apache.maven.author | 1 | 5 | 45 | 6 | 45 | 9 | 15 |
| org.apache.maven.author.resolver | 3 | 3 | 44 | 5 | 26 | 9 | 51 |
| Classes total | Functions total | NCSS total | Javadocs | Javadoc Lines | Single Comment Lines | Multi Comment Lines |
|---|---|---|---|---|---|---|
| 4 | 8 | 89 | 11 | 71 | 18 | 66 |
[ packages] [ objects][ functions][ explanations]
| Object | NCSS | Functions | Classes | Javadocs |
|---|---|---|---|---|
| org.apache.maven.author.FilesByAuthorProvider | 34 | 5 | 0 | 6 |
| org.apache.maven.author.resolver.JavadocAuthorResolver | 22 | 1 | 0 | 2 |
| org.apache.maven.author.resolver.SCMAuthorResolver | 7 | 1 | 0 | 2 |
| org.apache.maven.author.resolver.AuthorResolver | 2 | 1 | 0 | 1 |
| Object | NCSS | Functions | Classes | Javadocs |
|---|---|---|---|---|
| org.apache.maven.author.FilesByAuthorProvider | 34 | 5 | 0 | 6 |
| org.apache.maven.author.resolver.AuthorResolver | 2 | 1 | 0 | 1 |
| org.apache.maven.author.resolver.SCMAuthorResolver | 7 | 1 | 0 | 2 |
| org.apache.maven.author.resolver.JavadocAuthorResolver | 22 | 1 | 0 | 2 |
| NCSS average | Program NCSS | Classes average | Functions average | Javadocs average |
|---|---|---|---|---|
| 16.25 | 89.00 | 0.00 | 2.00 | 2.75 |
[ packages] [ objects][ functions][ explanations]
| Function | NCSS | CCN | Javadoc |
|---|---|---|---|
| org.apache.maven.author.resolver.JavadocAuthorResolver.resolveAuthors(File) | 20 | 11 | 1 |
| org.apache.maven.author.FilesByAuthorProvider.resolveAuthors(FileScanner,List) | 13 | 6 | 1 |
| org.apache.maven.author.FilesByAuthorProvider.addAuthorsForFileToMap(Map,String[],String) | 7 | 3 | 1 |
| org.apache.maven.author.FilesByAuthorProvider.resolveAuthorsForFile(File,AuthorResolver[]) | 6 | 4 | 1 |
| org.apache.maven.author.FilesByAuthorProvider.instanciateAuthorResolvers(List) | 6 | 2 | 1 |
| org.apache.maven.author.resolver.SCMAuthorResolver.resolveAuthors(File) | 6 | 5 | 1 |
| org.apache.maven.author.FilesByAuthorProvider.FilesByAuthorProvider() | 1 | 1 | 1 |
| org.apache.maven.author.resolver.AuthorResolver.resolveAuthors(File) | 1 | 1 | 0 |
| Program NCSS: | NCSS average | CCN average | Javadocs average |
|---|---|---|---|
| 89.00 | 7.50 | 4.13 | 0.88 |
[ packages] [ objects][ functions][ explanations]
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.
Actually, the NCSS counter gets incremented by one for each:
| Examples | Comment | |
|---|---|---|
| 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; |
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 "int a, b, c = 5, d = 6;" gets only +1 count, not four or even six (let me know if there is good reason to count it differently). |
| Method declaration | - public void cry();
- public void gib() throws DeadException { |
|
| Constructor declaration | public Foo() { | |
| Constructor invocation | - this();
- super(); |
|
| Statement | - i = 0;
- if (ok) - if (exit) { - if (3 == 4); - if (4 == 4) { ; } - } else { |
expression, if, else, while, do, for, switch, break, continue, return, throw, synchronized, catch, finally |
| Label | fine : | normal, case, default |
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.
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.
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:
An ordinary return at the end of method (no matter if it's a function or a procedure) will not be counted.
Note that else, default, and finallydon't increment the CCN value any further. On the other hand, a simple method with a switchstatement and a huge block of casestatements can have a surprisingly high CCN value (still it has the same value when converting a switchblock to an equivalent sequence of ifstatements).
The first article about this trivial software metric is one of the most cited papers in computer science. Sometimes you just must be the first to point out some basic shit and you are history. It seems just like a wonder that nobody was able to package Lines of Code in a more scientific manner. Now it's too late to label someone's name on it :).