##### Project Documentation

- About XJavaDoc
- Project Info
- Project Reports
  - Clover
  - StatCvs Report
  - Metrics
  - Checkstyle
  - Change Log
  - Developer Activity
  - File Activity
  - Project License
  - JavaDocs
  - JavaDoc Report
  - Source Xref
  - Test Xref
  - Unit Tests
  - Link Check Report
  - Task List
- Development Process

## Metric Results

[ summary] [ packages] [ cycles] [ explanations]

The following document contains the results of a JDependmetric analysis. The various metrics are defined at the bottom of this document.

## Summary

[ summary] [ packages] [ cycles] [ explanations]

Package | TC | AC | CC | AC | EC | A | I | D
--- | --- | --- | --- | --- | --- | --- | --- | ---
xjavadoc | 67 | 23 | 44 | 6 | 10 | 0.34 | 62% | 3%
xjavadoc.ant | 3 | 1 | 2 | 0 | 8 | 0.33 | 100% | 33%
xjavadoc.codeunit | 1 | 1 | 0 | 0 | 7 | 1 | 100% | 100%
xjavadoc.event | 4 | 2 | 2 | 1 | 3 | 0.5 | 75% | 25%
xjavadoc.filesystem | 6 | 1 | 5 | 3 | 4 | 0.17 | 57% | 26%
xjavadoc.predicates | 3 | 1 | 2 | 0 | 3 | 0.33 | 100% | 33%
xjavadoc.tags | 1 | 0 | 1 | 1 | 7 | 0 | 88% | 12%

## Packages

[ summary] [ packages] [ cycles] [ explanations]

### xjavadoc

Afferent Couplings | Efferent Couplings | Abstractness | Instability | Distance
--- | --- | --- | --- | ---
6 | 10 | 34% | 62% | 3%

Abstract Classes | Concrete Classes | Used by Packages | Uses Packages
--- | --- | --- | ---
AbstractClass AbstractExecutableMember AbstractProgramElement AbstractType JavaParser MemberImpl Named Node NodeParserConstants NodeParserTreeConstants SimpleParserConstants SourceSet Type XClass XConstructor XExecutableMember XField XMember XMethod XParameter XProgramElement XTag XType | BinaryClass ConstructorImpl DefaultXTag FieldImpl JJTNodeParserState JavaCharStream JavaDocReader MethodImpl NodeParser NodeParser$1 NodeParser$JJCalls NodeParser$Parameter NodeParserTokenManager NodePrinter ParameterImpl ParseException Primitive ReturnType SimpleNode SimpleParser SimpleParser$1 SimpleParser$JJCalls SimpleParser$Parameter SimpleParserTokenManager SourceClass TagValidationException TagValidator Token TokenMgrError UnknownClass UnknownTagException Util Util$1 Util$2 XDoc XDocTest XJavaDoc XJavaDoc$LogMessage XJavaDoc$NoInnerClassesPredicate XJavaDocException XMethod$PropertyAccessorPredicate XMethod$PropertyMutatorPredicate XPackage XTagFactory | xjavadoc.ant xjavadoc.codeunit xjavadoc.event xjavadoc.filesystem xjavadoc.predicates xjavadoc.tags | java.beans java.io java.lang java.lang.reflect java.util junit.framework org.apache.commons.collections xjavadoc.event xjavadoc.filesystem xjavadoc.tags

### xjavadoc.ant

Afferent Couplings | Efferent Couplings | Abstractness | Instability | Distance
--- | --- | --- | --- | ---
0 | 8 | 33% | 100% | 33%

Abstract Classes | Concrete Classes | Used by Packages | Uses Packages
--- | --- | --- | ---
XJavadocTask | XJavadocFilter XJavadocTask$1 | None | java.io java.lang java.util org.apache.tools.ant org.apache.tools.ant.types org.apache.tools.ant.types.selectors xjavadoc xjavadoc.filesystem

### xjavadoc.codeunit

Afferent Couplings | Efferent Couplings | Abstractness | Instability | Distance
--- | --- | --- | --- | ---
0 | 7 | 100% | 100% | 100%

Abstract Classes | Concrete Classes | Used by Packages | Uses Packages
--- | --- | --- | ---
CodeTestCase | None | None | java.io java.lang java.net java.util junit.framework xjavadoc xjavadoc.filesystem

### xjavadoc.event

Afferent Couplings | Efferent Couplings | Abstractness | Instability | Distance
--- | --- | --- | --- | ---
1 | 3 | 50% | 75% | 25%

Abstract Classes | Concrete Classes | Used by Packages | Uses Packages
--- | --- | --- | ---
XDocListener XTagListener | XDocEvent XTagEvent | xjavadoc | java.lang java.util xjavadoc

### xjavadoc.filesystem

Afferent Couplings | Efferent Couplings | Abstractness | Instability | Distance
--- | --- | --- | --- | ---
3 | 4 | 17% | 57% | 26%

Abstract Classes | Concrete Classes | Used by Packages | Uses Packages
--- | --- | --- | ---
AbstractFile | FileSourceSet FileSourceSet$DirectoryFilter FileSourceSet$JavaSourceFilter ReaderFile XJavadocFile | xjavadoc xjavadoc.ant xjavadoc.codeunit | java.io java.lang java.util xjavadoc

### xjavadoc.predicates

Afferent Couplings | Efferent Couplings | Abstractness | Instability | Distance
--- | --- | --- | --- | ---
0 | 3 | 33% | 100% | 33%

Abstract Classes | Concrete Classes | Used by Packages | Uses Packages
--- | --- | --- | ---
ProgramElementPredicate | HasTag TagAttributeEquals | None | java.lang org.apache.commons.collections xjavadoc

### xjavadoc.tags

Afferent Couplings | Efferent Couplings | Abstractness | Instability | Distance
--- | --- | --- | --- | ---
1 | 7 | 0% | 88% | 12%

Abstract Classes | Concrete Classes | Used by Packages | Uses Packages
--- | --- | --- | ---
None | TagIntrospector | xjavadoc | java.beans java.io java.lang java.net java.util java.util.jar xjavadoc

## Cycles

[ summary] [ packages] [ cycles] [ explanations]

Package | Cyclic Dependencies
--- | ---
xjavadoc | xjavadoc.event xjavadoc
xjavadoc.ant | xjavadoc xjavadoc.event xjavadoc
xjavadoc.codeunit | xjavadoc xjavadoc.event xjavadoc
xjavadoc.event | xjavadoc xjavadoc.event
xjavadoc.filesystem | xjavadoc xjavadoc.event xjavadoc
xjavadoc.predicates | xjavadoc xjavadoc.event xjavadoc
xjavadoc.tags | xjavadoc xjavadoc.event xjavadoc

## Explanations

[ summary] [ packages] [ cycles] [ explanations]

The following explanations are for quick reference and are lifted directly from the original JDepend documentation.

Term | Description
--- | ---
Number of Classes | The number of concrete and abstract classes (and interfaces) in the package is an indicator of the extensibility of the package.
Afferent Couplings | The number of other packages that depend upon classes within the package is an indicator of the package's responsibility.
Efferent Couplings | The number of other packages that the classes in the package depend upon is an indicator of the package's independence.
Abstractness | The ratio of the number of abstract classes (and interfaces) in the analyzed package to the total number of classes in the analyzed package. The range for this metric is 0 to 1, with A=0 indicating a completely concrete package and A=1 indicating a completely abstract package.
Instability | The ratio of efferent coupling (Ce) to total coupling (Ce / (Ce + Ca)). This metric is an indicator of the package's resilience to change. The range for this metric is 0 to 1, with I=0 indicating a completely stable package and I=1 indicating a completely instable package.
Distance | The perpendicular distance of a package from the idealized line A + I = 1. This metric is an indicator of the package's balance between abstractness and stability. A package squarely on the main sequence is optimally balanced with respect to its abstractness and stability. Ideal packages are either completely abstract and stable (x=0, y=1) or completely concrete and instable (x=1, y=0). The range for this metric is 0 to 1, with D=0 indicating a package that is coincident with the main sequence and D=1 indicating a package that is as far from the main sequence as possible.
Cycles | Packages participating in a package dependency cycle are in a deadly embrace with respect to reusability and their release cycle. Package dependency cycles can be easily identified by reviewing the textual reports of dependency cycles. Once these dependency cycles have been identified with JDepend, they can be broken by employing various object-oriented techniques.