The org.gmetrics.report.XmlReportWriter class produces an XML report of GMetrics results.
See a Sample Report.
The option element is a child of the report element and defines a report-specific option for a report.
org.gmetrics.report.BasicHtmlReportWriter supports the following options:
| Attribute | Description | Required |
| functions | The (comma-separated) list of functions for which results are included in the report for a particular metric. Multiple metrics are configured by separating them with semicolons (;). By default, all functions provided by a metric are included within the report. Any metrics not explicitly configured include all applicable functions as well. ---- Valid function values are metric-specific, but typically include "total", "average", "minimum" and "maximum". ---- For example, a value of "MethodLineCount=minimum,average" for functions includes only the minimum and average function results for the MethodLineCount metric. Likewise, a value of "ABC=average; CyclomaticComplexity=total,maximum" includes the average function results for the ABC metric and the total and maximum function results for the CyclomaticComplexity metric. Note that all functions provided by any other metrics (not configured) are included. | No |
| levels | The (comma-separated) list of levels at which results are included in the report for a particular metric. Multiple metrics are configured by separating them with semicolons (;). By default, all levels are included for all metrics within the report. Any metrics not explicitly configured include all applicable levels as well. ---- Valid level values are "package", "class" and "method". ---- For example, a value of "MethodLineCount=class,method" for levels includes only the class and method level results for the MethodLineCount metric. Likewise, a value of "ABC=method; CyclomaticComplexity=package,class" includes the method level results for the ABC metric and the package and class level results for the CyclomaticComplexity metric. Note that all levels are included for any other metrics not explicitly configured. | No |
| metrics | The (comma-separated) list of names of the metrics included in the report. By default, all metrics within the results are included in the report. ---- For example, a metrics value of "ABC, MethodLineCount" includes only the ABC and MethodLineCount metrics within the report. | No |
| outputFile | The path and filename for the output report file. | No |
| title | The title for the output report. | No |
| writeToStandardOut | Set to "true" or true to write out the report to stdout (System.out) instead of writing to a file. | No |
Here is an example Ant XML build file illustrating configuration of org.gmetrics.report.XmlReportWriter.
<taskdef name="gmetrics" classname="org.gmetrics.ant.GMetricsTask">
<target name="runGMetrics">
<gmetrics>
<report type="org.gmetrics.report.XmlReportWriter">
<option name="outputFile" value="SampleGMetricsXmlReport.html" />
</report>
<fileset dir="src">
<include name="**/*.groovy"/>
</fileset>
</gmetrics>
</target>
And here is an example illustrating explicit configuration of the metrics, levels and functions to be included within the report:
<taskdef name="gmetrics" classname="org.gmetrics.ant.GMetricsTask">
<target name="runGMetrics">
<gmetrics>
<report type="org.gmetrics.report.XmlReportWriter">
<option name="outputFile" value="SampleGMetricsXmlReport.html" />
<option name="metrics" value="CyclomaticComplexity, ABC" />
<option name="levels" value="CyclomaticComplexity=class,method; ABC=method" />
<option name="functions" value="ABC=average; CyclomaticComplexity=total,maximum" />
</report>
<fileset dir="src">
<include name="**/*.groovy"/>
</fileset>
</gmetrics>
</target>
The org.gmetrics.report.BasicHtmlReportWriter class produces an HTML report of metric results in a single HTML table, with one row for each package, class or method (or closure field) and one column for each metric value (function) being calculated.
See a Sample Report.
The option element is a child of the report element and defines a report-specific option for a report.
org.gmetrics.report.BasicHtmlReportWriter supports the following options:
| Attribute | Description | Required |
| functions | The (comma-separated) list of functions for which results are included in the report for a particular metric. Multiple metrics are configured by separating them with semicolons (;). By default, all functions provided by a metric are included within the report. Any metrics not explicitly configured include all applicable functions as well. ---- Valid function values are metric-specific, but typically include "total", "average", "minimum" and "maximum". ---- For example, a value of "MethodLineCount=minimum,average" for functions includes only the minimum and average function results for the MethodLineCount metric. Likewise, a value of "ABC=average; CyclomaticComplexity=total,maximum" includes the average function results for the ABC metric and the total and maximum function results for the CyclomaticComplexity metric. Note that all functions provided by any other metrics (not configured) are included. | No |
| levels | The (comma-separated) list of levels at which results are included in the report for a particular metric. Multiple metrics are configured by separating them with semicolons (;). By default, all levels are included for all metrics within the report. Any metrics not explicitly configured include all applicable levels as well. ---- Valid level values are "package", "class" and "method". ---- For example, a value of "MethodLineCount=class,method" for levels includes only the class and method level results for the MethodLineCount metric. Likewise, a value of "ABC=method; CyclomaticComplexity=package,class" includes the method level results for the ABC metric and the package and class level results for the CyclomaticComplexity metric. Note that all levels are included for any other metrics not explicitly configured. | No |
| metrics | The (comma-separated) list of names of the metrics included in the report. By default, all metrics within the results are included in the report. ---- For example, a metrics value of "ABC, MethodLineCount" includes only the ABC and MethodLineCount metrics within the report. | No |
| outputFile | The path and filename for the output report file. | No |
| title | The title for the output report. | No |
| writeToStandardOut | Set to "true" or true to write out the report to stdout (System.out) instead of writing to a file. | No |
Here is an example Ant XML build file illustrating configuration of org.gmetrics.report.BasicHtmlReportWriter.
<taskdef name="gmetrics" classname="org.gmetrics.ant.GMetricsTask">
<target name="runGMetrics">
<gmetrics>
<report type="org.gmetrics.report.BasicHtmlReportWriter">
<option name="outputFile" value="SampleGMetricsReport.html" />
<option name="title" value="Sample" />
</report>
<fileset dir="src">
<include name="**/*.groovy"/>
</fileset>
</gmetrics>
</target>
And here is an example illustrating explicit configuration of the metrics, levels and functions to be included within the report:
<taskdef name="gmetrics" classname="org.gmetrics.ant.GMetricsTask">
<target name="runGMetrics">
<gmetrics>
<report type="org.gmetrics.report.BasicHtmlReportWriter">
<option name="outputFile" value="SampleGMetricsReport.html" />
<option name="title" value="Sample" />
<option name="metrics" value="CyclomaticComplexity, ABC" />
<option name="levels" value="CyclomaticComplexity=class,method; ABC=method" />
<option name="functions" value="ABC=average; CyclomaticComplexity=total,maximum" />
</report>
<fileset dir="src">
<include name="**/*.groovy"/>
</fileset>
</gmetrics>
</target>
The GMetrics project provides calculation and reporting of size and complexity metrics for Groovy source code. GMetrics scans Groovy source code, applying a set of metrics, and generates an HTML report of the results.
You can run GMetrics using the supplied Ant Task.
Total and average values for the following metrics are provided:
See the site navigation menu for a list of the metrics and reports provided out of the box by GMetrics.
Take a look at a Sample GMetrics Report.
The GMetrics project requires:
For projects built using Maven, GMetrics is now available from the Maven Central Repository.
Metric for counting the number of fields within each class. Note that static final fields (i.e., constants) are included as well.
Implemented by the org.gmetrics.metric.fieldcount.FieldCountMetric class.
The following properties can be configured for this metric within a MetricSet. See Creating a MetricSet for information on the syntax of setting a metric property.
| Property | Description | Default Value |
| enabled | This boolean property controls whether the metric is enabled. If set to false, then the metric is not included as part of the results or the output reports. | true |
| functions | This List<String> property contains the names of the functions to be calculated at the method, class and package levels and (potentially) included within the report(s). Valid values are: - "total" - "average" - "minimum" - "maximum" | ["total","average"] |
Metric that measures the code coverage of branches (conditionals) based on a Cobertura coverage XML file.
Implemented by the org.gmetrics.metric.coverage.CoberturaBranchCoverageMetric class.
The following properties can be configured for this metric within a MetricSet. See Creating a MetricSet for information on the syntax of setting a metric property.
| Property | Description | Default Value |
| enabled | This boolean property controls whether the metric is enabled. If set to false, then the metric is not included as part of the results or the output reports. | true |
| functions | This List<String> property contains the names of the functions to be calculated at the class and package levels and (potentially) included within the report(s). Valid values are: - "total" - "average" - "minimum" - "maximum" | ["total","average"] |
| coberturaFile | The path to the Cobertura XML file. By default, the path is relative to the classpath. But the path may be optionally prefixed by any of the valid java.net.URL prefixes, such as "file:" (to load from a relative or absolute path on the filesystem), or "http:". This property is REQUIRED. | N/A |
| packageNamePrefixes | Optional, comma-separated list of prefixes that should be stripped from full path names before checking the Cobertura XML file for matching coverage information. For instance, if the GMetrics Ant task is configured to pull in all *.groovy files from "src/main/groovy/**", then all of the package paths will be prefixed with "src/main/groovy", which is not part of the actual package name recorded in the Cobertura XML file. In that case, set the packageNamePrefixes property to "src/main/groovy". | null |
Metric for counting the number of lines for classes. Note that this metric measures the number of lines from the first line of the class to the last line of the class. The count includes all program statements, comment lines and whitespace.
Implemented by the org.gmetrics.metric.linecount.ClassLineCountMetric class.
The following properties can be configured for this metric within a MetricSet. See Creating a MetricSet for information on the syntax of setting a metric property.
| Property | Description | Default Value |
| enabled | This boolean property controls whether the metric is enabled. If set to false, then the metric is not included as part of the results or the output reports. | true |
| functions | This List<String> property contains the names of the functions to be calculated at the class and package levels and (potentially) included within the report(s). Valid values are: - "total" - "average" - "minimum" - "maximum" | ["total","average"] |
Report timestamp: Jan 16, 2012 9:58:22 AM
| Package/Class/Method | Complexity (total) | Complexity (average) | Method Lines (total) | Method Lines (average) |
|---|---|---|---|---|
| [p] All packages | 640 | 1.7 | 2506 | 6.5 |
| [p] org | 640 | 1.7 | 2506 | 6.5 |
| [p] org/gmetrics | 640 | 1.7 | 2506 | 6.5 |
| [c] org.gmetrics.GMetricsRunner | 1 | 1.0 | 19 | 19.0 |
| [m] execute | 1 | 1 | 19 | 19 |
| [p] org/gmetrics/analyzer | 13 | 1.9 | 59 | 8.4 |
| [c] org.gmetrics.analyzer.AnalysisContext | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.analyzer.FilesystemSourceAnalyzer | 13 | 1.9 | 59 | 8.4 |
| [m] analyze | 1 | 1 | 8 | 8 |
| [m] getSourceDirectories | 1 | 1 | 3 | 3 |
| [m] processDirectory | 4 | 4 | 19 | 19 |
| [m] processFile | 3 | 3 | 13 | 13 |
| [m] applyMetricsToClass | 1 | 1 | 8 | 8 |
| [m] matches | 2 | 2 | 4 | 4 |
| [m] initializeWildcardPatterns | 1 | 1 | 4 | 4 |
| [c] org.gmetrics.analyzer.SourceAnalyzer | N/A | N/A | N/A | N/A |
| [p] org/gmetrics/ant | 34 | 1.5 | 148 | 6.7 |
| [c] org.gmetrics.ant.AntFileSetSourceAnalyzer | 24 | 1.6 | 109 | 7.3 |
| [m] analyze | 1 | 1 | 7 | 7 |
| [m] getSourceDirectories | 1 | 1 | 7 | 7 |
| [m] calculatePackageLevelMetricResults | 1 | 1 | 4 | 4 |
| [m] calculatePackageLevelMetricResults | 1 | 1 | 5 | 5 |
| [m] processFileSet | 2 | 2 | 13 | 13 |
| [m] processFile | 2 | 2 | 16 | 16 |
| [m] applyMetricsToClass | 1 | 1 | 8 | 8 |
| [m] findResultsNodeForPath | 1 | 1 | 3 | 3 |
| [m] findPackageResultsNodeForPath | 2 | 2 | 7 | 7 |
| [m] findPackageResultsNodeForPath | 1 | 1 | 4 | 4 |
| [m] resultFromFirstMatchOrElseNull | 2 | 2 | 7 | 7 |
| [m] findOrAddResultsNodeForPath | 3 | 3 | 12 | 12 |
| [m] removeBaseDirectoryPrefix | 2 | 2 | 7 | 7 |
| [m] removeLeadingSlash | 3 | 3 | 3 | 3 |
| [m] <init> | 1 | 1 | 6 | 6 |
| [c] org.gmetrics.ant.GMetricsTask | 9 | 1.5 | 36 | 6.0 |
| [m] execute | 2 | 2 | 15 | 15 |
| [m] addFileset | 1 | 1 | 4 | 4 |
| [m] addConfiguredReport | 2 | 2 | 10 | 10 |
| [m] createMetricSet | 2 | 2 | 3 | 3 |
| [m] createSourceAnalyzer | 1 | 1 | 3 | 3 |
| [m] createGMetricsRunner | 1 | 1 | 1 | 1 |
| [c] org.gmetrics.ant.Report | 1 | 1.0 | 3 | 3.0 |
| [m] addConfiguredOption | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.ant.ReportOption | N/A | N/A | N/A | N/A |
| [p] org/gmetrics/formatter | 4 | 1.3 | 19 | 6.3 |
| [c] org.gmetrics.formatter.Formatter | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.formatter.FormatterFactory | 1 | 1.0 | 6 | 6.0 |
| [m] getFormatter | 1 | 1 | 6 | 6 |
| [c] org.gmetrics.formatter.PercentageFormatter | 2 | 2.0 | 10 | 10.0 |
| [m] format | 2 | 2 | 10 | 10 |
| [c] org.gmetrics.formatter.ToStringFormatter | 1 | 1.0 | 3 | 3.0 |
| [m] format | 1 | 1 | 3 | 3 |
| [p] org/gmetrics/metric | 241 | 1.7 | 886 | 6.2 |
| [c] org.gmetrics.metric.AbstractAstVisitor | 6 | 1.5 | 16 | 4.0 |
| [m] isFirstVisit | 2 | 2 | 7 | 7 |
| [m] sourceLine | 1 | 1 | 3 | 3 |
| [m] getSourceUnit | 1 | 1 | 3 | 3 |
| [m] isSyntheticNonRunMethod | 2 | 2 | 3 | 3 |
| [c] org.gmetrics.metric.AbstractMethodMetric | 12 | 2.4 | 55 | 11.0 |
| [m] applyToMethod | 2 | 2 | 7 | 7 |
| [m] applyToClosure | 2 | 2 | 7 | 7 |
| [m] calculateForClass | 3 | 3 | 16 | 16 |
| [m] addClosureFieldsToMetricResults | 3 | 3 | 14 | 14 |
| [m] addMethodsToMetricResults | 2 | 2 | 11 | 11 |
| [c] org.gmetrics.metric.AbstractMetric | 8 | 1.6 | 23 | 4.6 |
| [m] applyToPackage | 2 | 2 | 6 | 6 |
| [m] calculateForPackage | 1 | 1 | 4 | 4 |
| [m] applyToClass | 2 | 2 | 6 | 6 |
| [m] isNotAnInterface | 1 | 1 | 3 | 3 |
| [m] createAggregateMetricResult | 2 | 2 | 4 | 4 |
| [c] org.gmetrics.metric.AstVisitor | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.metric.MethodMetric | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.metric.Metric | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.metric.MetricLevel | 3 | 1.0 | 9 | 3.0 |
| [m] getNames | 1 | 1 | 3 | 3 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 3 | 3 |
| [p] org/gmetrics/metric/abc | 67 | 1.6 | 231 | 5.5 |
| [c] org.gmetrics.metric.abc.AbcAstVisitor | 33 | 1.7 | 104 | 5.5 |
| [m] visitMethod | 3 | 3 | 6 | 6 |
| [m] visitBinaryExpression | 1 | 1 | 4 | 4 |
| [m] visitPrefixExpression | 1 | 1 | 4 | 4 |
| [m] visitPostfixExpression | 1 | 1 | 4 | 4 |
| [m] visitMethodCallExpression | 1 | 1 | 4 | 4 |
| [m] visitPropertyExpression | 1 | 1 | 5 | 5 |
| [m] visitConstructorCallExpression | 1 | 1 | 4 | 4 |
| [m] visitIfElse | 2 | 2 | 6 | 6 |
| [m] visitSwitch | 2 | 2 | 7 | 7 |
| [m] visitTryCatchFinally | 1 | 1 | 5 | 5 |
| [m] visitTernaryExpression | 1 | 1 | 4 | 4 |
| [m] visitBooleanExpression | 2 | 2 | 6 | 6 |
| [m] visitNotExpression | 2 | 2 | 6 | 6 |
| [m] handleExpressionContainingOperation | 5 | 5 | 12 | 12 |
| [m] countUnaryConditionals | 4 | 4 | 13 | 13 |
| [m] countUnaryConditionals | 1 | 1 | 4 | 4 |
| [m] isSingleVariable | 1 | 1 | 3 | 3 |
| [m] isFinalVariableDeclaration | 2 | 2 | 4 | 4 |
| [m] isNotEmptyStatement | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.metric.abc.AbcMetric | 5 | 1.7 | 19 | 6.3 |
| [m] calculate | 2 | 2 | 9 | 9 |
| [m] calculate | 1 | 1 | 6 | 6 |
| [m] createAggregateMetricResult | 2 | 2 | 4 | 4 |
| [c] org.gmetrics.metric.abc.AbcVector | 4 | 1.0 | 19 | 4.8 |
| [m] getMagnitude | 1 | 1 | 5 | 5 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] squared | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 8 | 8 |
| [p] org/gmetrics/metric/abc/result | 25 | 1.6 | 89 | 5.6 |
| [c] org.gmetrics.metric.abc.result.AbcMetricResult | 4 | 1.3 | 15 | 5.0 |
| [m] getAt | 2 | 2 | 3 | 3 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 9 | 9 |
| [c] org.gmetrics.metric.abc.result.AggregateAbcMetricResult | 21 | 1.6 | 74 | 5.7 |
| [m] calculateFunctions | 5 | 5 | 17 | 17 |
| [m] getCount | 1 | 1 | 3 | 3 |
| [m] getTotalAbcVector | 1 | 1 | 3 | 3 |
| [m] getAbcVector | 1 | 1 | 3 | 3 |
| [m] getAverageAbcVector | 1 | 1 | 6 | 6 |
| [m] getAt | 1 | 1 | 3 | 3 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] addChildrenToAbcVector | 1 | 1 | 8 | 8 |
| [m] calculateMinimum | 2 | 2 | 4 | 4 |
| [m] calculateMaximum | 2 | 2 | 4 | 4 |
| [m] includesFunction | 1 | 1 | 3 | 3 |
| [m] average | 3 | 3 | 8 | 8 |
| [m] <init> | 1 | 1 | 9 | 9 |
| [p] org/gmetrics/metric/classcount | 3 | 1.5 | 10 | 5.0 |
| [c] org.gmetrics.metric.classcount.ClassCountMetric | 3 | 1.5 | 10 | 5.0 |
| [m] calculateForClass | 1 | 1 | 5 | 5 |
| [m] calculateForPackage | 2 | 2 | 5 | 5 |
| [p] org/gmetrics/metric/coverage | 89 | 1.6 | 370 | 6.9 |
| [c] org.gmetrics.metric.coverage.AbstractCoberturaCoverageMetric | 27 | 1.9 | 122 | 8.7 |
| [m] applyToMethod | 2 | 2 | 7 | 7 |
| [m] applyToClosure | 1 | 1 | 4 | 4 |
| [m] calculateForClass | 4 | 4 | 21 | 21 |
| [m] calculateForPackage | 5 | 5 | 17 | 17 |
| [m] calculate | 1 | 1 | 6 | 6 |
| [m] getCoverageRatioForClass | 1 | 1 | 10 | 10 |
| [m] calculateCoverageForClassAndInnerClasses | 1 | 1 | 4 | 4 |
| [m] getOverallPackageMetricValue | 1 | 1 | 4 | 4 |
| [m] buildMethodResults | 3 | 3 | 16 | 16 |
| [m] calculateMethodResult | 2 | 2 | 9 | 9 |
| [m] logMissingMethodCoverageInformation | 2 | 2 | 6 | 6 |
| [m] findMethodElement | 1 | 1 | 6 | 6 |
| [m] containsClasses | 1 | 1 | 3 | 3 |
| [m] getCoberturaCoverageFile | 2 | 2 | 9 | 9 |
| [c] org.gmetrics.metric.coverage.CoberturaBranchCoverageMetric | 4 | 1.3 | 26 | 8.7 |
| [m] getCoverageRatioForSingleClass | 2 | 2 | 10 | 10 |
| [m] findLineElementsWithBranches | 1 | 1 | 3 | 3 |
| [m] getBranchCoverageRatio | 1 | 1 | 13 | 13 |
| [c] org.gmetrics.metric.coverage.CoberturaCoverageFile | 21 | 1.5 | 89 | 6.4 |
| [m] getOverallCoverageRate | 1 | 1 | 4 | 4 |
| [m] parseCoverageRate | 1 | 1 | 5 | 5 |
| [m] findMatchingPackageElement | 3 | 3 | 7 | 7 |
| [m] findPackageElementMatchingPrefix | 1 | 1 | 9 | 9 |
| [m] findPackageWithPrefix | 3 | 3 | 8 | 8 |
| [m] findPackageElement | 1 | 1 | 4 | 4 |
| [m] findClassElement | 1 | 1 | 4 | 4 |
| [m] findInnerClasses | 1 | 1 | 4 | 4 |
| [m] hasInnerClasses | 1 | 1 | 3 | 3 |
| [m] findMethodElement | 2 | 2 | 11 | 11 |
| [m] findAllMethodElements | 2 | 2 | 7 | 7 |
| [m] getCoberturaXml | 2 | 2 | 10 | 10 |
| [m] createNonValidatingXmlSlurper | 1 | 1 | 8 | 8 |
| [m] <init> | 1 | 1 | 5 | 5 |
| [c] org.gmetrics.metric.coverage.CoberturaLineCoverageMetric | 3 | 1.5 | 15 | 7.5 |
| [m] getCoverageRatioForSingleClass | 2 | 2 | 10 | 10 |
| [m] getLinesCoverageRatio | 1 | 1 | 5 | 5 |
| [c] org.gmetrics.metric.coverage.CoberturaSignatureParser | 20 | 2.0 | 75 | 7.5 |
| [m] matchesCoberturaMethod | 2 | 2 | 8 | 8 |
| [m] numberOfParameters | 1 | 1 | 3 | 3 |
| [m] parseSignatureParameterTypes | 3 | 3 | 16 | 16 |
| [m] extractParameters | 1 | 1 | 5 | 5 |
| [m] parseCoberturaSignatureParameterTypes | 2 | 2 | 7 | 7 |
| [m] parseParameterTypes | 2 | 2 | 12 | 12 |
| [m] processStandaloneCharacter | 4 | 4 | 11 | 11 |
| [m] processCharacterWithinFullyQualifiedTypeName | 2 | 2 | 8 | 8 |
| [m] classNameNoPackage | 2 | 2 | 4 | 4 |
| [m] <init> | 1 | 1 | 1 | 1 |
| [c] org.gmetrics.metric.coverage.CoberturaSignatureParser$ParseContext | 8 | 1.3 | 23 | 3.8 |
| [m] startFullyQualifiedTypeName | 1 | 1 | 3 | 3 |
| [m] withinFullyQualifiedTypeName | 1 | 1 | 3 | 3 |
| [m] appendToFullyQualifiedTypeName | 1 | 1 | 3 | 3 |
| [m] terminateFullyQualifiedTypeName | 2 | 2 | 6 | 6 |
| [m] startNewArrayType | 1 | 1 | 3 | 3 |
| [m] processPrimitiveTypeCode | 2 | 2 | 5 | 5 |
| [c] org.gmetrics.metric.coverage.Ratio | 6 | 1.2 | 20 | 4.0 |
| [m] plus | 1 | 1 | 4 | 4 |
| [m] toBigDecimal | 2 | 2 | 4 | 4 |
| [m] asType | 1 | 1 | 4 | 4 |
| [m] toString | 1 | 1 | 4 | 4 |
| [m] <init> | 1 | 1 | 4 | 4 |
| [p] org/gmetrics/metric/crap | 10 | 3.3 | 36 | 12.0 |
| [c] org.gmetrics.metric.crap.CrapMetric | 10 | 3.3 | 36 | 12.0 |
| [m] calculate | 1 | 1 | 4 | 4 |
| [m] calculate | 6 | 6 | 24 | 24 |
| [m] calculateCrapScore | 3 | 3 | 8 | 8 |
| [p] org/gmetrics/metric/cyclomatic | 18 | 1.5 | 58 | 4.8 |
| [c] org.gmetrics.metric.cyclomatic.CyclomaticComplexityAstVisitor | 14 | 1.4 | 46 | 4.6 |
| [m] visitMethod | 3 | 3 | 8 | 8 |
| [m] visitIfElse | 1 | 1 | 4 | 4 |
| [m] visitWhileLoop | 1 | 1 | 4 | 4 |
| [m] visitForLoop | 1 | 1 | 4 | 4 |
| [m] visitSwitch | 1 | 1 | 4 | 4 |
| [m] visitCatchStatement | 1 | 1 | 4 | 4 |
| [m] visitBinaryExpression | 1 | 1 | 4 | 4 |
| [m] visitTernaryExpression | 1 | 1 | 4 | 4 |
| [m] visitPropertyExpression | 2 | 2 | 4 | 4 |
| [m] handleExpressionContainingOperation | 2 | 2 | 6 | 6 |
| [c] org.gmetrics.metric.cyclomatic.CyclomaticComplexityMetric | 4 | 2.0 | 12 | 6.0 |
| [m] calculate | 2 | 2 | 6 | 6 |
| [m] calculate | 2 | 2 | 6 | 6 |
| [p] org/gmetrics/metric/fieldcount | 6 | 2.0 | 19 | 6.3 |
| [c] org.gmetrics.metric.fieldcount.FieldCountAstVisitor | 4 | 2.0 | 10 | 5.0 |
| [m] getNumberOfFields | 1 | 1 | 3 | 3 |
| [m] visitClass | 3 | 3 | 7 | 7 |
| [c] org.gmetrics.metric.fieldcount.FieldCountMetric | 2 | 2.0 | 9 | 9.0 |
| [m] calculateForClass | 2 | 2 | 9 | 9 |
| [p] org/gmetrics/metric/linecount | 12 | 2.0 | 38 | 6.3 |
| [c] org.gmetrics.metric.linecount.ClassLineCountMetric | 2 | 2.0 | 9 | 9.0 |
| [m] calculateForClass | 2 | 2 | 9 | 9 |
| [c] org.gmetrics.metric.linecount.ClassLineCountAstVisitor | 2 | 2.0 | 6 | 6.0 |
| [m] visitClass | 2 | 2 | 6 | 6 |
| [c] org.gmetrics.metric.linecount.MethodLineCountAstVisitor | 5 | 2.5 | 12 | 6.0 |
| [m] visitMethod | 3 | 3 | 6 | 6 |
| [m] visitClosureExpression | 2 | 2 | 6 | 6 |
| [c] org.gmetrics.metric.linecount.MethodLineCountMetric | 3 | 1.5 | 11 | 5.5 |
| [m] calculate | 2 | 2 | 6 | 6 |
| [m] calculate | 1 | 1 | 5 | 5 |
| [p] org/gmetrics/metric/methodcount | 7 | 2.3 | 21 | 7.0 |
| [c] org.gmetrics.metric.methodcount.MethodCountAstVisitor | 5 | 2.5 | 12 | 6.0 |
| [m] getNumberOfMethods | 1 | 1 | 3 | 3 |
| [m] visitClass | 4 | 4 | 9 | 9 |
| [c] org.gmetrics.metric.methodcount.MethodCountMetric | 2 | 2.0 | 9 | 9.0 |
| [m] calculateForClass | 2 | 2 | 9 | 9 |
| [p] org/gmetrics/metricregistry | 3 | 1.0 | 16 | 5.3 |
| [c] org.gmetrics.metricregistry.DefaultMetricRegistry | 3 | 1.0 | 16 | 5.3 |
| [m] getMetricClass | 1 | 1 | 4 | 4 |
| [m] getAllMetricNames | 1 | 1 | 4 | 4 |
| [m] buildMetricClassMap | 1 | 1 | 8 | 8 |
| [c] org.gmetrics.metricregistry.MetricRegistry | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.metricregistry.MetricRegistryHolder | N/A | N/A | N/A | N/A |
| [p] org/gmetrics/metricset | 28 | 1.1 | 143 | 5.7 |
| [c] org.gmetrics.metricset.CompositeMetricSet | 3 | 1.0 | 11 | 3.7 |
| [m] addMetric | 1 | 1 | 4 | 4 |
| [m] addMetricSet | 1 | 1 | 4 | 4 |
| [m] getMetrics | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.metricset.DefaultMetricSet | 1 | 1.0 | 3 | 3.0 |
| [m] getMetrics | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.metricset.GroovyDslMetricSet | 2 | 1.0 | 21 | 10.5 |
| [m] getMetrics | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 18 | 18 |
| [c] org.gmetrics.metricset.ListMetricSet | 2 | 1.0 | 10 | 5.0 |
| [m] getMetrics | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 7 | 7 |
| [c] org.gmetrics.metricset.MetricSet | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.metricset.MetricSetBuilder | 2 | 1.0 | 7 | 3.5 |
| [m] metricset | 1 | 1 | 4 | 4 |
| [m] getMetricSet | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.metricset.TopLevelDelegate | 14 | 1.2 | 70 | 5.8 |
| [m] metricset | 1 | 1 | 4 | 4 |
| [m] metricset | 1 | 1 | 10 | 10 |
| [m] metric | 1 | 1 | 5 | 5 |
| [m] metric | 1 | 1 | 6 | 6 |
| [m] metric | 1 | 1 | 10 | 10 |
| [m] propertyMissing | 1 | 1 | 5 | 5 |
| [m] methodMissing | 2 | 2 | 10 | 10 |
| [m] description | 1 | 1 | 4 | 4 |
| [m] getMetricSet | 1 | 1 | 3 | 3 |
| [m] assertClassImplementsMetricInterface | 1 | 1 | 4 | 4 |
| [m] addMetric | 2 | 2 | 6 | 6 |
| [m] isNotWithinAnotherMetricDefinition | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.metricset.MetricSetDelegate | 4 | 1.3 | 21 | 7.0 |
| [m] methodMissing | 2 | 2 | 15 | 15 |
| [m] findMetric | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 3 | 3 |
| [p] org/gmetrics/report | 132 | 1.6 | 648 | 8.0 |
| [c] org.gmetrics.report.AbstractMetricCriteriaFilter | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.report.AbstractReportWriter | 20 | 1.7 | 76 | 6.3 |
| [m] writeReport | 2 | 2 | 14 | 14 |
| [m] writeReportToStandardOut | 1 | 1 | 4 | 4 |
| [m] writeReportToFile | 2 | 2 | 8 | 8 |
| [m] initializeDefaultResourceBundle | 2 | 2 | 12 | 12 |
| [m] getResourceBundleString | 2 | 2 | 9 | 9 |
| [m] getResourceBundleStringOrNull | 2 | 2 | 9 | 9 |
| [m] initializeFormatters | 2 | 2 | 7 | 7 |
| [m] formatMetricResultValue | 2 | 2 | 4 | 4 |
| [m] getFormattedTimestamp | 1 | 1 | 4 | 4 |
| [m] isWriteToStandardOut | 2 | 2 | 3 | 3 |
| [m] initializeResourceBundle | 1 | 1 | 1 | 1 |
| [m] getTimestamp | 1 | 1 | 1 | 1 |
| [c] org.gmetrics.report.BasicHtmlReportWriter | 27 | 1.8 | 168 | 11.2 |
| [m] writeReport | 1 | 1 | 17 | 17 |
| [m] buildMetricResultColumns | 2 | 2 | 11 | 11 |
| [m] buildCSS | 1 | 1 | 8 | 8 |
| [m] buildHeaderSection | 1 | 1 | 8 | 8 |
| [m] buildBodySection | 1 | 1 | 11 | 11 |
| [m] buildReportTimestamp | 1 | 1 | 6 | 6 |
| [m] buildResultsTable | 2 | 2 | 17 | 17 |
| [m] getMetricResultColumnHeading | 1 | 1 | 4 | 4 |
| [m] buildResultsTableRowRecursively | 8 | 8 | 30 | 30 |
| [m] buildResultsRowForLevel | 2 | 2 | 9 | 9 |
| [m] prefixForResultsNodeLevel | 1 | 1 | 8 | 8 |
| [m] buildMetricDescriptions | 2 | 2 | 24 | 24 |
| [m] getDescriptionForMetricName | 1 | 1 | 4 | 4 |
| [m] buildVersionFooter | 1 | 1 | 8 | 8 |
| [m] buildTitle | 2 | 2 | 3 | 3 |
| [c] org.gmetrics.report.FunctionsCriteriaFilter | 2 | 1.0 | 6 | 3.0 |
| [m] setFunctions | 1 | 1 | 3 | 3 |
| [m] includesFunction | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.report.LevelsCriteriaFilter | 2 | 1.0 | 6 | 3.0 |
| [m] setLevels | 1 | 1 | 3 | 3 |
| [m] includesLevel | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.report.MetricCriteriaFilterHelper | 6 | 1.5 | 23 | 5.8 |
| [m] includesName | 3 | 3 | 7 | 7 |
| [m] parseCriteria | 1 | 1 | 7 | 7 |
| [m] parseCriteriaForSingleMetric | 1 | 1 | 6 | 6 |
| [m] parseCommaSeparatedList | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.report.MetricsCriteriaFilter | 3 | 1.5 | 6 | 3.0 |
| [m] setMetrics | 1 | 1 | 3 | 3 |
| [m] includesMetric | 2 | 2 | 3 | 3 |
| [c] org.gmetrics.report.ReportWriter | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.report.SeriesValue | 2 | 1.0 | 7 | 3.5 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 4 | 4 |
| [c] org.gmetrics.report.SingleSeriesCriteriaFilter | 33 | 1.9 | 131 | 7.7 |
| [m] buildSeriesData | 1 | 1 | 20 | 20 |
| [m] findMatchingValuesForChildren | 1 | 1 | 6 | 6 |
| [m] getResultsNodeFullName | 3 | 3 | 14 | 14 |
| [m] findMatchingValues | 4 | 4 | 15 | 15 |
| [m] sortValuesIfApplicable | 3 | 3 | 9 | 9 |
| [m] limitToGreaterThanIfApplicable | 2 | 2 | 7 | 7 |
| [m] limitToLessThanIfApplicable | 2 | 2 | 7 | 7 |
| [m] limitToMaxResultsIfApplicable | 3 | 3 | 9 | 9 |
| [m] assertMetricExists | 1 | 1 | 4 | 4 |
| [m] assertLevelExists | 1 | 1 | 3 | 3 |
| [m] assertFunctionExists | 1 | 1 | 4 | 4 |
| [m] assertValidSortValue | 2 | 2 | 3 | 3 |
| [m] assertValidMaxResultsValue | 3 | 3 | 11 | 11 |
| [m] assertValidGreaterThanValue | 1 | 1 | 3 | 3 |
| [m] assertValidLessThanValue | 1 | 1 | 3 | 3 |
| [m] assertValidNumberValue | 3 | 3 | 10 | 10 |
| [m] findMetric | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.report.SingleSeriesHtmlReportWriter | 11 | 1.1 | 96 | 9.6 |
| [m] writeReport | 1 | 1 | 18 | 18 |
| [m] buildHeaderSection | 1 | 1 | 8 | 8 |
| [m] buildCSS | 1 | 1 | 8 | 8 |
| [m] buildBodySection | 2 | 2 | 13 | 13 |
| [m] buildReportTimestamp | 1 | 1 | 6 | 6 |
| [m] buildResultsTable | 1 | 1 | 13 | 13 |
| [m] getSeriesValueNameHeading | 1 | 1 | 9 | 9 |
| [m] buildSeriesValueRow | 1 | 1 | 9 | 9 |
| [m] getMetricResultColumnHeading | 1 | 1 | 4 | 4 |
| [m] buildVersionFooter | 1 | 1 | 8 | 8 |
| [c] org.gmetrics.report.XmlReportWriter | 26 | 1.7 | 129 | 8.6 |
| [m] writeReport | 1 | 1 | 17 | 17 |
| [m] buildReportElement | 1 | 1 | 5 | 5 |
| [m] buildProjectElement | 1 | 1 | 9 | 9 |
| [m] buildPackageElements | 1 | 1 | 3 | 3 |
| [m] buildElement | 4 | 4 | 7 | 7 |
| [m] buildPackageElement | 5 | 5 | 20 | 20 |
| [m] buildClassElement | 1 | 1 | 10 | 10 |
| [m] buildMethodElement | 1 | 1 | 10 | 10 |
| [m] buildMetricElements | 1 | 1 | 7 | 7 |
| [m] buildMetricElement | 5 | 5 | 14 | 14 |
| [m] isRoot | 1 | 1 | 3 | 3 |
| [m] buildMetricsElement | 1 | 1 | 14 | 14 |
| [m] getDescriptionForMetric | 1 | 1 | 4 | 4 |
| [m] isPackage | 1 | 1 | 3 | 3 |
| [m] cdata | 1 | 1 | 3 | 3 |
| [p] org/gmetrics/result | 39 | 1.5 | 125 | 4.8 |
| [c] org.gmetrics.result.ClassMetricResult | 2 | 1.0 | 7 | 3.5 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 4 | 4 |
| [c] org.gmetrics.result.FunctionNames | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.result.MethodKey | 6 | 1.2 | 23 | 4.6 |
| [m] equals | 2 | 2 | 4 | 4 |
| [m] hashCode | 1 | 1 | 4 | 4 |
| [m] toString | 1 | 1 | 4 | 4 |
| [m] <init> | 1 | 1 | 5 | 5 |
| [m] <init> | 1 | 1 | 6 | 6 |
| [c] org.gmetrics.result.MetricResult | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.result.MetricResultBuilder | 23 | 1.8 | 64 | 4.9 |
| [m] createAggregateMetricResult | 1 | 1 | 13 | 13 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] calculateFunctions | 1 | 1 | 10 | 10 |
| [m] calculateCount | 1 | 1 | 3 | 3 |
| [m] total | 2 | 2 | 3 | 3 |
| [m] calculateTotal | 2 | 2 | 5 | 5 |
| [m] minimum | 2 | 2 | 3 | 3 |
| [m] calculateMinimum | 2 | 2 | 4 | 4 |
| [m] maximum | 2 | 2 | 3 | 3 |
| [m] calculateMaximum | 2 | 2 | 4 | 4 |
| [m] average | 2 | 2 | 3 | 3 |
| [m] calculateAverage | 3 | 3 | 7 | 7 |
| [m] shouldCalculateFunction | 2 | 2 | 3 | 3 |
| [c] org.gmetrics.result.NumberMetricResult | 4 | 1.3 | 16 | 5.3 |
| [m] getAt | 2 | 2 | 3 | 3 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 10 | 10 |
| [c] org.gmetrics.result.SingleNumberMetricResult | 4 | 1.3 | 15 | 5.0 |
| [m] getAt | 2 | 2 | 3 | 3 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 9 | 9 |
| [p] org/gmetrics/resultsnode | 27 | 1.2 | 99 | 4.5 |
| [c] org.gmetrics.resultsnode.ClassResultsNode | 8 | 1.3 | 29 | 4.8 |
| [m] containsClassResults | 1 | 1 | 3 | 3 |
| [m] getMetricResult | 1 | 1 | 4 | 4 |
| [m] addClassMetricResult | 2 | 2 | 10 | 10 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] addMethodMetricResult | 2 | 2 | 6 | 6 |
| [m] <init> | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.resultsnode.MethodResultsNode | 7 | 1.0 | 24 | 3.4 |
| [m] containsClassResults | 1 | 1 | 3 | 3 |
| [m] getMetricResult | 1 | 1 | 4 | 4 |
| [m] addMetricResult | 1 | 1 | 4 | 4 |
| [m] getChildren | 1 | 1 | 3 | 3 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 4 | 4 |
| [c] org.gmetrics.resultsnode.PackageResultsNode | 12 | 1.3 | 46 | 5.1 |
| [m] getChildren | 1 | 1 | 3 | 3 |
| [m] containsClassResults | 1 | 1 | 3 | 3 |
| [m] getMetricResult | 1 | 1 | 4 | 4 |
| [m] addChildIfNotEmpty | 2 | 2 | 7 | 7 |
| [m] addChild | 1 | 1 | 5 | 5 |
| [m] applyMetric | 3 | 3 | 14 | 14 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 4 | 4 |
| [c] org.gmetrics.resultsnode.ResultsNode | N/A | N/A | N/A | N/A |
| [p] org/gmetrics/source | 37 | 2.1 | 111 | 6.2 |
| [c] org.gmetrics.source.AbstractSourceCode | 16 | 2.7 | 51 | 8.5 |
| [m] getLines | 2 | 2 | 6 | 6 |
| [m] line | 3 | 3 | 5 | 5 |
| [m] getAst | 3 | 3 | 16 | 16 |
| [m] getLineNumberForCharacterIndex | 5 | 5 | 16 | 16 |
| [m] isValid | 1 | 1 | 3 | 3 |
| [m] normalizePath | 2 | 2 | 5 | 5 |
| [c] org.gmetrics.source.SourceCode | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.source.SourceCodeCriteria | 8 | 8.0 | 17 | 17.0 |
| [m] matches | 8 | 8 | 17 | 17 |
| [c] org.gmetrics.source.SourceFile | 7 | 1.2 | 25 | 4.2 |
| [m] getName | 1 | 1 | 3 | 3 |
| [m] getPath | 1 | 1 | 3 | 3 |
| [m] getText | 2 | 2 | 6 | 6 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] createSourceUnit | 1 | 1 | 5 | 5 |
| [m] <init> | 1 | 1 | 5 | 5 |
| [c] org.gmetrics.source.SourceString | 6 | 1.2 | 18 | 3.6 |
| [m] getText | 1 | 1 | 3 | 3 |
| [m] setPath | 2 | 2 | 3 | 3 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] createSourceUnit | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 6 | 6 |
| [p] org/gmetrics/util | 81 | 2.4 | 233 | 6.9 |
| [c] org.gmetrics.util.AstUtil | 38 | 2.5 | 94 | 6.3 |
| [m] isEmptyMethod | 1 | 1 | 3 | 3 |
| [m] isClosureField | 2 | 2 | 3 | 3 |
| [m] isBlock | 1 | 1 | 3 | 3 |
| [m] isEmptyBlock | 4 | 4 | 5 | 5 |
| [m] getMethodArguments | 3 | 3 | 10 | 10 |
| [m] isMethodCall | 3 | 3 | 10 | 10 |
| [m] isMethodCall | 2 | 2 | 4 | 4 |
| [m] isMethodCall | 3 | 3 | 9 | 9 |
| [m] isMethodNamed | 1 | 1 | 4 | 4 |
| [m] getAnnotation | 2 | 2 | 6 | 6 |
| [m] getVariableExpressions | 9 | 9 | 16 | 16 |
| [m] isFinalVariable | 4 | 4 | 14 | 14 |
| [m] isFromGeneratedSourceCode | 1 | 1 | 3 | 3 |
| [m] respondsTo | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 1 | 1 |
| [c] org.gmetrics.util.GMetricsVersion | 1 | 1.0 | 3 | 3.0 |
| [m] getVersion | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.util.PathUtil | 13 | 2.6 | 33 | 6.6 |
| [m] getName | 3 | 3 | 7 | 7 |
| [m] getParent | 3 | 3 | 9 | 9 |
| [m] normalize | 2 | 2 | 3 | 3 |
| [m] toPackageName | 4 | 4 | 13 | 13 |
| [m] <init> | 1 | 1 | 1 | 1 |
| [c] org.gmetrics.util.PropertyUtil | 6 | 3.0 | 23 | 11.5 |
| [m] setPropertyFromString | 5 | 5 | 22 | 22 |
| [m] <init> | 1 | 1 | 1 | 1 |
| [c] org.gmetrics.util.WildcardPattern | 13 | 3.3 | 46 | 11.5 |
| [m] matches | 4 | 4 | 7 | 7 |
| [m] containsWildcards | 1 | 1 | 3 | 3 |
| [m] convertStringWithWildcardsToRegex | 5 | 5 | 24 | 24 |
| [m] <init> | 3 | 3 | 12 | 12 |
| [p] org/gmetrics/util/io | 10 | 1.4 | 34 | 4.9 |
| [c] org.gmetrics.util.io.ClassPathResource | 4 | 1.3 | 14 | 4.7 |
| [m] getInputStream | 1 | 1 | 3 | 3 |
| [m] getInputStream | 2 | 2 | 7 | 7 |
| [m] <init> | 1 | 1 | 4 | 4 |
| [c] org.gmetrics.util.io.DefaultResourceFactory | 4 | 2.0 | 12 | 6.0 |
| [m] getResource | 3 | 3 | 9 | 9 |
| [m] isUrl | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.util.io.Resource | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.util.io.ResourceFactory | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.util.io.UrlResource | 2 | 1.0 | 8 | 4.0 |
| [m] getInputStream | 1 | 1 | 4 | 4 |
| [m] <init> | 1 | 1 | 4 | 4 |
| # | Metric Name | Description |
|---|---|---|
| 1 | CyclomaticComplexity | Measures the (McCabe) Cyclomatic Complexity of source code. See the Wikipedia entry for Cyclomatic Complexity. |
| 2 | MethodLineCount | Counts the number of lines in each method. |
Typically the licenses listed for the project are that of the project itself, and not of dependencies.
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
This document provides an overview of the various documents and links that are part of this project's general information. All of this content is automatically generated by Maven on behalf of the project.
| Document | Description |
|---|---|
| Dependencies | This document lists the project's dependencies and provides information on each dependency. |
| Project License | This is a link to the definitions of project licenses. |
The following is a list of compile dependencies for this project. These dependencies are required to compile and run the application:
| GroupId | ArtifactId | Version | Type |
|---|---|---|---|
| log4j | log4j | 1.2.13 | jar |
| org.apache.ant | ant | 1.7.1 | jar |
| org.codehaus.groovy | groovy-all | 1.7.5 | jar |
The following is a list of transitive dependencies for this project. Transitive dependencies are the dependencies of the project dependencies.
The following is a list of compile dependencies for this project. These dependencies are required to compile and run the application:
| GroupId | ArtifactId | Version | Type |
|---|---|---|---|
| org.apache.ant | ant-launcher | 1.7.1 | jar |
Apache 2: CodeNarc, GMetrics
Unknown: Groovy, Log4j, Unnamed - org.apache.ant:ant-launcher:jar:1.7.1, org.apache.tools.ant
Common Public License Version 1.0: JUnit
| Filename | Size | Entries | Classes | Packages | JDK Rev | Debug |
|---|---|---|---|---|---|---|
| junit-3.8.2.jar | 117.81 kB | 120 | 102 | 6 | 1.2 | debug |
| log4j-1.2.13.jar | 349.79 kB | 283 | 253 | 19 | 1.1 | debug |
| ant-1.7.1.jar | 1.26 MB | 818 | 769 | 29 | 1.2 | debug |
| ant-launcher-1.7.1.jar | 11.86 kB | 12 | 5 | 1 | 1.2 | debug |
| groovy-all-1.7.5.jar | 5.23 MB | 3,476 | 3,297 | 89 | 1.5 | debug |
| CodeNarc-0.16.jar | 3.44 MB | 998 | 920 | 35 | 1.5 | debug |
| Total | Size | Entries | Classes | Packages | JDK Rev | Debug |
| 6 | 10.40 MB | 5,707 | 5,346 | 179 | 1.5 | 6 |
| compile: 4 | compile: 6.84 MB | compile: 4,589 | compile: 4,324 | compile: 138 | - | compile: 4 |
| test: 2 | test: 3.56 MB | test: 1,118 | test: 1,022 | test: 41 | - | test: 2 |
| Repo ID | URL | Release | Snapshot |
|---|---|---|---|
| sonatype-nexus-snapshots | https://oss.sonatype.org/content/repositories/snapshots | - | Yes |
| central | http://repo1.maven.org/maven2 | Yes | - |
Repository locations for each of the Dependencies.
| Artifact | sonatype-nexus-snapshots | central |
|---|---|---|
| junit:junit:jar:3.8.2 | - |  |
| log4j:log4j:jar:1.2.13 | - | |
| org.apache.ant:ant:jar:1.7.1 | - | |
| org.apache.ant:ant-launcher:jar:1.7.1 | - | |
| org.codehaus.groovy:groovy-all:jar:1.7.5 | - | |
| org.codenarc:CodeNarc:jar:0.16 | - | |
| Total | sonatype-nexus-snapshots | central |
| 6 (compile: 4, test: 2) | 0 | 6 |
Metric for counting the number methods and closure fields within each class. Note that this metric counts methods and constructors.
Implemented by the org.gmetrics.metric.methodcount.MethodCountMetric class.
The following properties can be configured for this metric within a MetricSet. See Creating a MetricSet for information on the syntax of setting a metric property.
| Property | Description | Default Value |
| enabled | This boolean property controls whether the metric is enabled. If set to false, then the metric is not included as part of the results or the output reports. | true |
| functions | This List<String> property contains the names of the functions to be calculated at the method, class and package levels and (potentially) included within the report(s). Valid values are: - "total" - "average" - "minimum" - "maximum" | ["total","average"] |
Calculates the ABC Metric for a class or method. ABC is a metric of size/complexity that counts the number of Assignments (A), Branches (B) and Conditions (C) and assigns a single numerical score calculated as:
|ABC| = sqrt((A*A)+(B*B)+(C*C))
Implemented by the org.gmetrics.metric.abc.AbcMetric class.
The ABC Metric calculation rules for Groovy:
A frequently-referenced blog post by Jake Scruggs ([4]) offers the following guidelines for interpreting an ABC score. Note that these values refer to the score (magnitude) calculated for a single method:
The following properties can be configured for this metric within a MetricSet. See Creating a MetricSet for information on the syntax of setting a metric property.
| Property | Description | Default Value |
| enabled | This boolean property controls whether the metric is enabled. If set to false, then the metric is not included as part of the results or the output reports. | true |
| functions | This List<String> property contains the names of the functions to be calculated at the method, class and package levels and (potentially) included within the report(s). Valid values are: - "total" - "average" - "minimum" - "maximum" | ["total","average"] |
| includeClosureFields | This boolean property controls whether metric values are calculated for Closure Fields and treated as methods. A Closure Field is a field that is initialized to a Closure Expression, e.g., def myField = { println 12 }. | true |
See a Sample Report from the org.gmetrics.report.BasicHtmlReportWriter ReportWriter.
See a Sample Report from the org.gmetrics.report.SingleSeriesHtmlReportWriter ReportWriter.
See a See a Sample Report from the org.gmetrics.report.XmlReportWriter ReportWriter.
MrHaki has written a detailed blog post describing How to Create a GMetrics Report with XSLT
If no MetricSet is configured for the GMetrics Ant Task then it uses the set of Metrics defined by the org.gmetrics.metricset.DefaultMetricSet class. That includes the following Metrics:
The org.gmetrics.report.SingleSeriesHtmlReportWriter class produces an HTML report of metric results based on a single metric, single level and single function to provide a single series of data.
The metric, level and function properties are required (must be non-null and non-empty). These three properties uniquely identify a single series of metric values.
See a Sample Report.
The option element is a child of the report element and defines a report-specific option for a report.
org.gmetrics.report.SingleSeriesHtmlReportWriter supports the following options:
| Attribute | Description | Required |
| metric | The name (case-sensitive) of a single Metric included in the analysis results (e.g. "CyclomaticComplexity"). | Yes |
| level | The single level at which results are included in the report. Valid level values are "package", "class" and "method". | Yes |
| function | The function for which results are included in the report. Valid function values are metric-specific, but are typically "total", "average", "minimum" or "maximum". | Yes |
| outputFile | The path and filename for the output report file. | No |
| title | The title for the output report. | No |
| writeToStandardOut | Set to "true" or true to write out the report to stdout (System.out) instead of writing to a file. | No |
| sort | Controls whether the report results are sorted numerically. A value of null or empty means no sorting is performed; otherwise, the value must be either "ascending" or "descending". | No |
| maxResults | Specifies the limit on the number of results included in the report. A value of null, zero or empty means no limit is applied; otherwise the value must be a positive integer. | No |
| greaterThan | Specifies a lower-bound threshold -- only results with a larger value are included within the report. A value of null or empty means no lower-bound threshold is applied. | No |
| lessThan | Specifies an upper-bound threshold -- only results with a smaller value are included within the report. A value of null or empty means no upper-bound threshold is applied. | No |
Here is an example Ant XML build file illustrating configuration of org.gmetrics.report.SingleSeriesHtmlReportWriter.
<taskdef name="gmetrics" classname="org.gmetrics.ant.GMetricsTask">
<target name="runGMetrics">
<gmetrics>
<report type="org.gmetrics.report.SingleSeriesHtmlReportWriter">
<option name="outputFile" value="SampleGMetricsReport.html" />
<option name="title" value="Sample" />
<option name="metric" value="CyclomaticComplexity" />
<option name="level" value="class" />
<option name="function" value="average" />
<option name="maxResults" value="50" />
<option name="greaterThan" value="100.0" />
</report>
<fileset dir="src">
<include name="**/*.groovy"/>
</fileset>
</gmetrics>
</target>
Metric that measures the code coverage of source lines based on a Cobertura coverage XML file.
Implemented by the org.gmetrics.metric.coverage.CoberturaLineCoverageMetric class.
The following properties can be configured for this metric within a MetricSet. See Creating a MetricSet for information on the syntax of setting a metric property.
| Property | Description | Default Value |
| enabled | This boolean property controls whether the metric is enabled. If set to false, then the metric is not included as part of the results or the output reports. | true |
| functions | This List<String> property contains the names of the functions to be calculated at the class and package levels and (potentially) included within the report(s). Valid values are: - "total" - "average" - "minimum" - "maximum" | ["total","average"] |
| coberturaFile | The path to the Cobertura XML file. By default, the path is relative to the classpath. But the path may be optionally prefixed by any of the valid java.net.URL prefixes, such as "file:" (to load from a relative or absolute path on the filesystem), or "http:". This property is REQUIRED. | N/A |
| packageNamePrefixes | Optional, comma-separated list of prefixes that should be stripped from full path names before checking the Cobertura XML file for matching coverage information. For instance, if the GMetrics Ant task is configured to pull in all *.groovy files from "src/main/groovy/**", then all of the package paths will be prefixed with "src/main/groovy", which is not part of the actual package name recorded in the Cobertura XML file. In that case, set the packageNamePrefixes property to "src/main/groovy". | null |
Measures the C.R.A.P. (Change Risk Anti-Patterns) score. It is designed to analyze and predict the amount of effort, pain, and time required to maintain an existing body of code.
A method with a CRAP score over 30 is considered CRAPpy (i.e., unacceptable, offensive, etc.). [2]
Implemented by the org.gmetrics.metric.crap.CrapMetric class.
Given a Groovy method m, C.R.A.P. for m is calculated as follows:
C.R.A.P.(m) = comp(m)^2 * (1 – cov(m)/100)^3 + comp(m)
Where comp(m) is the cyclomatic complexity of method m, and cov(m) is the test code coverage provided by automated tests.
The following properties can be configured for this metric within a MetricSet. See Creating a MetricSet for information on the syntax of setting a metric property.
| Property | Description | Default Value |
| enabled | This boolean property controls whether the metric is enabled. If set to false, then the metric is not included as part of the results or the output reports. | true |
| functions | This List<String> property contains the names of the functions to be calculated at the class and package levels and (potentially) included within the report(s). Valid values are: - "total" - "average" - "minimum" - "maximum" | ["total","average"] |
| coverageMetric | The GMetrics Metric instance to provide code coverage data. GMetrics includes a Cobertura-based coverage metric. See CoberturaLineCoverageMetric This property is REQUIRED. | N/A |
| complexityMetric | The GMetrics Metric instance to provide cyclomatic complexity data. GMetrics includes a CyclomaticComplexityMetric, which is used as the default provider. | An instance of CyclomaticComplexityMetric |
Here is a sample MetricSet definition that includes a CrapMetric.
final COBERTURA_FILE = 'coverage/GMetrics/coverage.xml'
metricset {
def coberturaMetric = CoberturaLineCoverage {
coberturaFile = COBERTURA_FILE
functions = ['total']
}
CRAP {
functions = ['total']
coverageMetric = coberturaMetric
}
}
Note setting the coverageMetric field is required.
The CRAP metric is a special composite metric -- it uses other metrics to calculate complexity and code coverage. In the example above, the CoberturaLineCoverage metric is also included within the MetricSet being defined. Alternatively, if you define the CoberturaLineCoverage metric within the CRAP metric definition, then the CoberturaLineCoverage metric is not included within the MetricSet, as in the example below.
final COBERTURA_FILE = 'coverage/GMetrics/coverage.xml'
metricset {
CRAP {
// CoberturaLineCoverage is not included in the MetricSet
coverageMetric = CoberturaLineCoverage {
coberturaFile = COBERTURA_FILE
}
}
}
There is one annoying known limitation with that behavior. If you use the Map syntax, rather than the Closure syntax, to define the outer metric, then inner metric is also included within the MetricSet, as in the example below.
metricset {
// Both CRAP and CoberturaLineCoverage metrics are included in the MetricSet
CRAP(coverageMetric:CoberturaLineCoverage(coberturaFile:'coverage/GMetrics/coverage.xml'))
}
| Attribute | Description | Required |
| metricSetFile | The paths to a Groovy MetricSet DSL file. By default, the path specified is relative to the classpath, but it may be optionally prefixed by any of the valid java.net.URL prefixes, such as "file:" (to load from a relative or absolute filesystem path), or "http:". If not specified, it uses the set of Metrics defined by the Default MetricSet. | NO |
The <report> nested element defines the type and options for a report. It includes a type attribute and contains optional nested <option> elements.
NOTE: Currently, org.gmetrics.report.BasicHtmlReportWriter is the only report provided with GMetrics.
| Attribute | Description | Required |
| type | The fully-qualified class name for the report class. This class must implement the org.gmetrics.report.ReportWriter interface. | Yes |
The <option> element is a child of the <report> element and defines a report-specific option for a report. See the Example below.
At least one fileset nested element is required, and is used to specify the source files that GMetrics should analyze. This is the standard Ant FileSet, and is quite powerful and flexible. See the Apache Ant Manual for more information on FileSets.
Here is an example Ant XML build file.
<taskdef name="gmetrics" classname="org.gmetrics.ant.GMetricsTask">
<target name="runGMetrics">
<gmetrics metricSetFile="config/metricset.groovy">
<report type="org.gmetrics.report.BasicHtmlReportWriter">
<option name="outputFile" value="SampleGMetricsReport.html" />
<option name="title" value="Sample" />
</report>
<fileset dir="src">
<include name="**/*.groovy"/>
</fileset>
</gmetrics>
</target>
Things to note:
GMetrics provides a Groovy DSL (domain-specific language) for defining MetricSets.
The preferred syntax for defining a MetricSet is to specify the list of Metrics using the Metric names. Here is simple example:
metricset {
description 'A simple MetricSet'
ClassCount // specify metric name only (note no "Metric" suffix on metric name)
FieldCount { // configure the Metric using a Closure
functions = ['total']
}
MethodCount([functions:['total']) // configure the Metric using a Map of properties
}
Things to note:
Here is an example of a more comprehensive Groovy MetricSet file, illustrating specifying Metrics by Metric class or Metric name, and also nested MetricSet files:
import org.gmetrics.metric.cyclomatic.CyclomaticComplexityMetric
metricset {
description 'An example MetricSet'
metricset("MyMetricSet.groovy")
metric(org.gmetrics.metric.abc.AbcMetric) {
functions = ['average', 'maximum']
}
metric(CyclomaticComplexityMetric) // specify metric class (see import)
ClassCount // specify metric name only (note no "Metric" suffix on metric name)
FieldCount { // specify metric name only
functions = ['total']
}
metricset("somepath/MyOtherMetricSet.groovy") {
ClassLineCount {
enabled = false
}
MethodLineCount name:'CustomMethodLineCount'
}
}
Things to note:
About the "inner" metricset statements:
About the metric statements:
Metric for counting the number of classes in each package. This metric counts the number of classes, interfaces and enums within a package.
Implemented by the org.gmetrics.metric.classcount.ClassCountMetric class.
The following properties can be configured for this metric within a MetricSet. See Creating a MetricSet for information on the syntax of setting a metric property.
| Property | Description | Default Value |
| enabled | This boolean property controls whether the metric is enabled. If set to false, then the metric is not included as part of the results or the output reports. | true |
| functions | This List<String> property contains the names of the functions to be calculated at the class and package levels and (potentially) included within the report(s). Valid values are: - "total" - "average" - "minimum" - "maximum" | ["total","average"] |
Calculates the Cyclomatic Complexity Metric for a class or method. Cyclomatic Complexity is a metric of complexity that counts the number of independent paths through the source code, and assigns a single numerical score for each method. The Cyclomatic Complexity score can also serve as an upper bound for the number of test cases that are necessary to achieve a complete branch coverage for a particular method ([1]).
Implemented by the org.gmetrics.metric.cyclomatic.CyclomaticComplexityMetric class.
The Cyclomatic Complexity Metric calculates a value for each method. Furthermore, if a class field is initialized to a Closure (ClosureExpression), then that Closure is analyzed just like a method.
The value of 10 is often considered as the threshold between acceptable (low risk) code and too complex (higher risk). See [1] and [2], for instance. As McCabe ([1]) says, "The particular upper bound that has been used for cyclomatic complexity is 10 which seems like a reasonable, but not magical, upper limit."
Other sources cite 15 as a useful threshold, and/or draw further delineations between low/medium/high/unacceptable complexity values. NDepend ([4]), for instance, recommends that methods with a score of "15 are hard to understand and maintain. Methods where CC is higher than 30 are extremely complex and should be split." On the other hand, [5] categorizes cyclomatic complexity scores into the following levels:
The following properties can be configured for this metric within a MetricSet. See Creating a MetricSet for information on the syntax of setting a metric property.
| Property | Description | Default Value |
| enabled | This boolean property controls whether the metric is enabled. If set to false, then the metric is not included as part of the results or the output reports. | true |
| functions | This List<String> property contains the names of the functions to be calculated at the method, class and package levels and (potentially) included within the report(s). Valid values are: - "total" - "average" - "minimum" - "maximum" | ["total","average"] |
| includeClosureFields | This boolean property controls whether metric values are calculated for Closure Fields and treated as methods. A Closure Field is a field that is initialized to a Closure Expression, e.g., def myField = { println 12 }. | true |
| Method | Method Lines (total) |
|---|---|
| org.gmetrics.report.BasicHtmlReportWriter#buildResultsTableRowRecursively | 30 |
| org.gmetrics.metric.crap.CrapMetric#calculate | 24 |
| org.gmetrics.report.BasicHtmlReportWriter#buildMetricDescriptions | 24 |
| org.gmetrics.util.WildcardPattern#convertStringWithWildcardsToRegex | 24 |
| org.gmetrics.util.PropertyUtil#setPropertyFromString | 22 |
| org.gmetrics.metric.coverage.AbstractCoberturaCoverageMetric#calculateForClass | 21 |
| org.gmetrics.report.SingleSeriesCriteriaFilter#buildSeriesData | 20 |
| org.gmetrics.report.XmlReportWriter#buildPackageElement | 20 |
| org.gmetrics.GMetricsRunner#execute | 19 |
| org.gmetrics.analyzer.FilesystemSourceAnalyzer#processDirectory | 19 |
| org.gmetrics.metricset.GroovyDslMetricSet#<init> | 18 |
| org.gmetrics.report.SingleSeriesHtmlReportWriter#writeReport | 18 |
| org.gmetrics.metric.abc.result.AggregateAbcMetricResult#calculateFunctions | 17 |
| org.gmetrics.metric.coverage.AbstractCoberturaCoverageMetric#calculateForPackage | 17 |
| org.gmetrics.report.BasicHtmlReportWriter#writeReport | 17 |
| org.gmetrics.report.BasicHtmlReportWriter#buildResultsTable | 17 |
| org.gmetrics.report.XmlReportWriter#writeReport | 17 |
| org.gmetrics.source.SourceCodeCriteria#matches | 17 |
| org.gmetrics.ant.AntFileSetSourceAnalyzer#processFile | 16 |
| org.gmetrics.metric.AbstractMethodMetric#calculateForClass | 16 |
This document provides an overview of the various reports that are automatically generated by Maven . Each report is briefly described below.
| Document | Description |
|---|---|
| Cobertura Test Coverage | Cobertura Test Coverage Report. |
| JavaDocs | JavaDoc API documentation. |
| Test JavaDocs | Test JavaDoc API documentation. |
Metric for counting the number of lines for methods and closure fields. Note that this metric measures the number of lines from the first line of the method to the last line of the metric. The count includes all program statements, comment lines and whitespace.
Implemented by the org.gmetrics.metric.linecount.MethodLineCountMetric class.
The following properties can be configured for this metric within a MetricSet. See Creating a MetricSet for information on the syntax of setting a metric property.
| Property | Description | Default Value |
| enabled | This boolean property controls whether the metric is enabled. If set to false, then the metric is not included as part of the results or the output reports. | true |
| functions | This List<String> property contains the names of the functions to be calculated at the method, class and package levels and (potentially) included within the report(s). Valid values are: - "total" - "average" - "minimum" - "maximum" | ["total","average"] |
| includeClosureFields | This boolean property controls whether metric values are calculated for Closure Fields and treated as methods. A Closure Field is a field that is initialized to a Closure Expression, e.g., def myField = { println 12 }. | true |
Report timestamp: Jan 16, 2012 9:58:22 AM
| Package/Class/Method | Complexity (total) | Complexity (average) | Method Lines (total) | Method Lines (average) |
|---|---|---|---|---|
| [p] All packages | 640 | 1.7 | 2506 | 6.5 |
| [p] org | 640 | 1.7 | 2506 | 6.5 |
| [p] org/gmetrics | 640 | 1.7 | 2506 | 6.5 |
| [c] org.gmetrics.GMetricsRunner | 1 | 1.0 | 19 | 19.0 |
| [m] execute | 1 | 1 | 19 | 19 |
| [p] org/gmetrics/analyzer | 13 | 1.9 | 59 | 8.4 |
| [c] org.gmetrics.analyzer.AnalysisContext | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.analyzer.FilesystemSourceAnalyzer | 13 | 1.9 | 59 | 8.4 |
| [m] analyze | 1 | 1 | 8 | 8 |
| [m] getSourceDirectories | 1 | 1 | 3 | 3 |
| [m] processDirectory | 4 | 4 | 19 | 19 |
| [m] processFile | 3 | 3 | 13 | 13 |
| [m] applyMetricsToClass | 1 | 1 | 8 | 8 |
| [m] matches | 2 | 2 | 4 | 4 |
| [m] initializeWildcardPatterns | 1 | 1 | 4 | 4 |
| [c] org.gmetrics.analyzer.SourceAnalyzer | N/A | N/A | N/A | N/A |
| [p] org/gmetrics/ant | 34 | 1.5 | 148 | 6.7 |
| [c] org.gmetrics.ant.AntFileSetSourceAnalyzer | 24 | 1.6 | 109 | 7.3 |
| [m] analyze | 1 | 1 | 7 | 7 |
| [m] getSourceDirectories | 1 | 1 | 7 | 7 |
| [m] calculatePackageLevelMetricResults | 1 | 1 | 4 | 4 |
| [m] calculatePackageLevelMetricResults | 1 | 1 | 5 | 5 |
| [m] processFileSet | 2 | 2 | 13 | 13 |
| [m] processFile | 2 | 2 | 16 | 16 |
| [m] applyMetricsToClass | 1 | 1 | 8 | 8 |
| [m] findResultsNodeForPath | 1 | 1 | 3 | 3 |
| [m] findPackageResultsNodeForPath | 2 | 2 | 7 | 7 |
| [m] findPackageResultsNodeForPath | 1 | 1 | 4 | 4 |
| [m] resultFromFirstMatchOrElseNull | 2 | 2 | 7 | 7 |
| [m] findOrAddResultsNodeForPath | 3 | 3 | 12 | 12 |
| [m] removeBaseDirectoryPrefix | 2 | 2 | 7 | 7 |
| [m] removeLeadingSlash | 3 | 3 | 3 | 3 |
| [m] <init> | 1 | 1 | 6 | 6 |
| [c] org.gmetrics.ant.GMetricsTask | 9 | 1.5 | 36 | 6.0 |
| [m] execute | 2 | 2 | 15 | 15 |
| [m] addFileset | 1 | 1 | 4 | 4 |
| [m] addConfiguredReport | 2 | 2 | 10 | 10 |
| [m] createMetricSet | 2 | 2 | 3 | 3 |
| [m] createSourceAnalyzer | 1 | 1 | 3 | 3 |
| [m] createGMetricsRunner | 1 | 1 | 1 | 1 |
| [c] org.gmetrics.ant.Report | 1 | 1.0 | 3 | 3.0 |
| [m] addConfiguredOption | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.ant.ReportOption | N/A | N/A | N/A | N/A |
| [p] org/gmetrics/formatter | 4 | 1.3 | 19 | 6.3 |
| [c] org.gmetrics.formatter.Formatter | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.formatter.FormatterFactory | 1 | 1.0 | 6 | 6.0 |
| [m] getFormatter | 1 | 1 | 6 | 6 |
| [c] org.gmetrics.formatter.PercentageFormatter | 2 | 2.0 | 10 | 10.0 |
| [m] format | 2 | 2 | 10 | 10 |
| [c] org.gmetrics.formatter.ToStringFormatter | 1 | 1.0 | 3 | 3.0 |
| [m] format | 1 | 1 | 3 | 3 |
| [p] org/gmetrics/metric | 241 | 1.7 | 886 | 6.2 |
| [c] org.gmetrics.metric.AbstractAstVisitor | 6 | 1.5 | 16 | 4.0 |
| [m] isFirstVisit | 2 | 2 | 7 | 7 |
| [m] sourceLine | 1 | 1 | 3 | 3 |
| [m] getSourceUnit | 1 | 1 | 3 | 3 |
| [m] isSyntheticNonRunMethod | 2 | 2 | 3 | 3 |
| [c] org.gmetrics.metric.AbstractMethodMetric | 12 | 2.4 | 55 | 11.0 |
| [m] applyToMethod | 2 | 2 | 7 | 7 |
| [m] applyToClosure | 2 | 2 | 7 | 7 |
| [m] calculateForClass | 3 | 3 | 16 | 16 |
| [m] addClosureFieldsToMetricResults | 3 | 3 | 14 | 14 |
| [m] addMethodsToMetricResults | 2 | 2 | 11 | 11 |
| [c] org.gmetrics.metric.AbstractMetric | 8 | 1.6 | 23 | 4.6 |
| [m] applyToPackage | 2 | 2 | 6 | 6 |
| [m] calculateForPackage | 1 | 1 | 4 | 4 |
| [m] applyToClass | 2 | 2 | 6 | 6 |
| [m] isNotAnInterface | 1 | 1 | 3 | 3 |
| [m] createAggregateMetricResult | 2 | 2 | 4 | 4 |
| [c] org.gmetrics.metric.AstVisitor | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.metric.MethodMetric | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.metric.Metric | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.metric.MetricLevel | 3 | 1.0 | 9 | 3.0 |
| [m] getNames | 1 | 1 | 3 | 3 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 3 | 3 |
| [p] org/gmetrics/metric/abc | 67 | 1.6 | 231 | 5.5 |
| [c] org.gmetrics.metric.abc.AbcAstVisitor | 33 | 1.7 | 104 | 5.5 |
| [m] visitMethod | 3 | 3 | 6 | 6 |
| [m] visitBinaryExpression | 1 | 1 | 4 | 4 |
| [m] visitPrefixExpression | 1 | 1 | 4 | 4 |
| [m] visitPostfixExpression | 1 | 1 | 4 | 4 |
| [m] visitMethodCallExpression | 1 | 1 | 4 | 4 |
| [m] visitPropertyExpression | 1 | 1 | 5 | 5 |
| [m] visitConstructorCallExpression | 1 | 1 | 4 | 4 |
| [m] visitIfElse | 2 | 2 | 6 | 6 |
| [m] visitSwitch | 2 | 2 | 7 | 7 |
| [m] visitTryCatchFinally | 1 | 1 | 5 | 5 |
| [m] visitTernaryExpression | 1 | 1 | 4 | 4 |
| [m] visitBooleanExpression | 2 | 2 | 6 | 6 |
| [m] visitNotExpression | 2 | 2 | 6 | 6 |
| [m] handleExpressionContainingOperation | 5 | 5 | 12 | 12 |
| [m] countUnaryConditionals | 4 | 4 | 13 | 13 |
| [m] countUnaryConditionals | 1 | 1 | 4 | 4 |
| [m] isSingleVariable | 1 | 1 | 3 | 3 |
| [m] isFinalVariableDeclaration | 2 | 2 | 4 | 4 |
| [m] isNotEmptyStatement | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.metric.abc.AbcMetric | 5 | 1.7 | 19 | 6.3 |
| [m] calculate | 2 | 2 | 9 | 9 |
| [m] calculate | 1 | 1 | 6 | 6 |
| [m] createAggregateMetricResult | 2 | 2 | 4 | 4 |
| [c] org.gmetrics.metric.abc.AbcVector | 4 | 1.0 | 19 | 4.8 |
| [m] getMagnitude | 1 | 1 | 5 | 5 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] squared | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 8 | 8 |
| [p] org/gmetrics/metric/abc/result | 25 | 1.6 | 89 | 5.6 |
| [c] org.gmetrics.metric.abc.result.AbcMetricResult | 4 | 1.3 | 15 | 5.0 |
| [m] getAt | 2 | 2 | 3 | 3 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 9 | 9 |
| [c] org.gmetrics.metric.abc.result.AggregateAbcMetricResult | 21 | 1.6 | 74 | 5.7 |
| [m] calculateFunctions | 5 | 5 | 17 | 17 |
| [m] getCount | 1 | 1 | 3 | 3 |
| [m] getTotalAbcVector | 1 | 1 | 3 | 3 |
| [m] getAbcVector | 1 | 1 | 3 | 3 |
| [m] getAverageAbcVector | 1 | 1 | 6 | 6 |
| [m] getAt | 1 | 1 | 3 | 3 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] addChildrenToAbcVector | 1 | 1 | 8 | 8 |
| [m] calculateMinimum | 2 | 2 | 4 | 4 |
| [m] calculateMaximum | 2 | 2 | 4 | 4 |
| [m] includesFunction | 1 | 1 | 3 | 3 |
| [m] average | 3 | 3 | 8 | 8 |
| [m] <init> | 1 | 1 | 9 | 9 |
| [p] org/gmetrics/metric/classcount | 3 | 1.5 | 10 | 5.0 |
| [c] org.gmetrics.metric.classcount.ClassCountMetric | 3 | 1.5 | 10 | 5.0 |
| [m] calculateForClass | 1 | 1 | 5 | 5 |
| [m] calculateForPackage | 2 | 2 | 5 | 5 |
| [p] org/gmetrics/metric/coverage | 89 | 1.6 | 370 | 6.9 |
| [c] org.gmetrics.metric.coverage.AbstractCoberturaCoverageMetric | 27 | 1.9 | 122 | 8.7 |
| [m] applyToMethod | 2 | 2 | 7 | 7 |
| [m] applyToClosure | 1 | 1 | 4 | 4 |
| [m] calculateForClass | 4 | 4 | 21 | 21 |
| [m] calculateForPackage | 5 | 5 | 17 | 17 |
| [m] calculate | 1 | 1 | 6 | 6 |
| [m] getCoverageRatioForClass | 1 | 1 | 10 | 10 |
| [m] calculateCoverageForClassAndInnerClasses | 1 | 1 | 4 | 4 |
| [m] getOverallPackageMetricValue | 1 | 1 | 4 | 4 |
| [m] buildMethodResults | 3 | 3 | 16 | 16 |
| [m] calculateMethodResult | 2 | 2 | 9 | 9 |
| [m] logMissingMethodCoverageInformation | 2 | 2 | 6 | 6 |
| [m] findMethodElement | 1 | 1 | 6 | 6 |
| [m] containsClasses | 1 | 1 | 3 | 3 |
| [m] getCoberturaCoverageFile | 2 | 2 | 9 | 9 |
| [c] org.gmetrics.metric.coverage.CoberturaBranchCoverageMetric | 4 | 1.3 | 26 | 8.7 |
| [m] getCoverageRatioForSingleClass | 2 | 2 | 10 | 10 |
| [m] findLineElementsWithBranches | 1 | 1 | 3 | 3 |
| [m] getBranchCoverageRatio | 1 | 1 | 13 | 13 |
| [c] org.gmetrics.metric.coverage.CoberturaCoverageFile | 21 | 1.5 | 89 | 6.4 |
| [m] getOverallCoverageRate | 1 | 1 | 4 | 4 |
| [m] parseCoverageRate | 1 | 1 | 5 | 5 |
| [m] findMatchingPackageElement | 3 | 3 | 7 | 7 |
| [m] findPackageElementMatchingPrefix | 1 | 1 | 9 | 9 |
| [m] findPackageWithPrefix | 3 | 3 | 8 | 8 |
| [m] findPackageElement | 1 | 1 | 4 | 4 |
| [m] findClassElement | 1 | 1 | 4 | 4 |
| [m] findInnerClasses | 1 | 1 | 4 | 4 |
| [m] hasInnerClasses | 1 | 1 | 3 | 3 |
| [m] findMethodElement | 2 | 2 | 11 | 11 |
| [m] findAllMethodElements | 2 | 2 | 7 | 7 |
| [m] getCoberturaXml | 2 | 2 | 10 | 10 |
| [m] createNonValidatingXmlSlurper | 1 | 1 | 8 | 8 |
| [m] <init> | 1 | 1 | 5 | 5 |
| [c] org.gmetrics.metric.coverage.CoberturaLineCoverageMetric | 3 | 1.5 | 15 | 7.5 |
| [m] getCoverageRatioForSingleClass | 2 | 2 | 10 | 10 |
| [m] getLinesCoverageRatio | 1 | 1 | 5 | 5 |
| [c] org.gmetrics.metric.coverage.CoberturaSignatureParser | 20 | 2.0 | 75 | 7.5 |
| [m] matchesCoberturaMethod | 2 | 2 | 8 | 8 |
| [m] numberOfParameters | 1 | 1 | 3 | 3 |
| [m] parseSignatureParameterTypes | 3 | 3 | 16 | 16 |
| [m] extractParameters | 1 | 1 | 5 | 5 |
| [m] parseCoberturaSignatureParameterTypes | 2 | 2 | 7 | 7 |
| [m] parseParameterTypes | 2 | 2 | 12 | 12 |
| [m] processStandaloneCharacter | 4 | 4 | 11 | 11 |
| [m] processCharacterWithinFullyQualifiedTypeName | 2 | 2 | 8 | 8 |
| [m] classNameNoPackage | 2 | 2 | 4 | 4 |
| [m] <init> | 1 | 1 | 1 | 1 |
| [c] org.gmetrics.metric.coverage.CoberturaSignatureParser$ParseContext | 8 | 1.3 | 23 | 3.8 |
| [m] startFullyQualifiedTypeName | 1 | 1 | 3 | 3 |
| [m] withinFullyQualifiedTypeName | 1 | 1 | 3 | 3 |
| [m] appendToFullyQualifiedTypeName | 1 | 1 | 3 | 3 |
| [m] terminateFullyQualifiedTypeName | 2 | 2 | 6 | 6 |
| [m] startNewArrayType | 1 | 1 | 3 | 3 |
| [m] processPrimitiveTypeCode | 2 | 2 | 5 | 5 |
| [c] org.gmetrics.metric.coverage.Ratio | 6 | 1.2 | 20 | 4.0 |
| [m] plus | 1 | 1 | 4 | 4 |
| [m] toBigDecimal | 2 | 2 | 4 | 4 |
| [m] asType | 1 | 1 | 4 | 4 |
| [m] toString | 1 | 1 | 4 | 4 |
| [m] <init> | 1 | 1 | 4 | 4 |
| [p] org/gmetrics/metric/crap | 10 | 3.3 | 36 | 12.0 |
| [c] org.gmetrics.metric.crap.CrapMetric | 10 | 3.3 | 36 | 12.0 |
| [m] calculate | 1 | 1 | 4 | 4 |
| [m] calculate | 6 | 6 | 24 | 24 |
| [m] calculateCrapScore | 3 | 3 | 8 | 8 |
| [p] org/gmetrics/metric/cyclomatic | 18 | 1.5 | 58 | 4.8 |
| [c] org.gmetrics.metric.cyclomatic.CyclomaticComplexityAstVisitor | 14 | 1.4 | 46 | 4.6 |
| [m] visitMethod | 3 | 3 | 8 | 8 |
| [m] visitIfElse | 1 | 1 | 4 | 4 |
| [m] visitWhileLoop | 1 | 1 | 4 | 4 |
| [m] visitForLoop | 1 | 1 | 4 | 4 |
| [m] visitSwitch | 1 | 1 | 4 | 4 |
| [m] visitCatchStatement | 1 | 1 | 4 | 4 |
| [m] visitBinaryExpression | 1 | 1 | 4 | 4 |
| [m] visitTernaryExpression | 1 | 1 | 4 | 4 |
| [m] visitPropertyExpression | 2 | 2 | 4 | 4 |
| [m] handleExpressionContainingOperation | 2 | 2 | 6 | 6 |
| [c] org.gmetrics.metric.cyclomatic.CyclomaticComplexityMetric | 4 | 2.0 | 12 | 6.0 |
| [m] calculate | 2 | 2 | 6 | 6 |
| [m] calculate | 2 | 2 | 6 | 6 |
| [p] org/gmetrics/metric/fieldcount | 6 | 2.0 | 19 | 6.3 |
| [c] org.gmetrics.metric.fieldcount.FieldCountAstVisitor | 4 | 2.0 | 10 | 5.0 |
| [m] getNumberOfFields | 1 | 1 | 3 | 3 |
| [m] visitClass | 3 | 3 | 7 | 7 |
| [c] org.gmetrics.metric.fieldcount.FieldCountMetric | 2 | 2.0 | 9 | 9.0 |
| [m] calculateForClass | 2 | 2 | 9 | 9 |
| [p] org/gmetrics/metric/linecount | 12 | 2.0 | 38 | 6.3 |
| [c] org.gmetrics.metric.linecount.ClassLineCountMetric | 2 | 2.0 | 9 | 9.0 |
| [m] calculateForClass | 2 | 2 | 9 | 9 |
| [c] org.gmetrics.metric.linecount.ClassLineCountAstVisitor | 2 | 2.0 | 6 | 6.0 |
| [m] visitClass | 2 | 2 | 6 | 6 |
| [c] org.gmetrics.metric.linecount.MethodLineCountAstVisitor | 5 | 2.5 | 12 | 6.0 |
| [m] visitMethod | 3 | 3 | 6 | 6 |
| [m] visitClosureExpression | 2 | 2 | 6 | 6 |
| [c] org.gmetrics.metric.linecount.MethodLineCountMetric | 3 | 1.5 | 11 | 5.5 |
| [m] calculate | 2 | 2 | 6 | 6 |
| [m] calculate | 1 | 1 | 5 | 5 |
| [p] org/gmetrics/metric/methodcount | 7 | 2.3 | 21 | 7.0 |
| [c] org.gmetrics.metric.methodcount.MethodCountAstVisitor | 5 | 2.5 | 12 | 6.0 |
| [m] getNumberOfMethods | 1 | 1 | 3 | 3 |
| [m] visitClass | 4 | 4 | 9 | 9 |
| [c] org.gmetrics.metric.methodcount.MethodCountMetric | 2 | 2.0 | 9 | 9.0 |
| [m] calculateForClass | 2 | 2 | 9 | 9 |
| [p] org/gmetrics/metricregistry | 3 | 1.0 | 16 | 5.3 |
| [c] org.gmetrics.metricregistry.DefaultMetricRegistry | 3 | 1.0 | 16 | 5.3 |
| [m] getMetricClass | 1 | 1 | 4 | 4 |
| [m] getAllMetricNames | 1 | 1 | 4 | 4 |
| [m] buildMetricClassMap | 1 | 1 | 8 | 8 |
| [c] org.gmetrics.metricregistry.MetricRegistry | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.metricregistry.MetricRegistryHolder | N/A | N/A | N/A | N/A |
| [p] org/gmetrics/metricset | 28 | 1.1 | 143 | 5.7 |
| [c] org.gmetrics.metricset.CompositeMetricSet | 3 | 1.0 | 11 | 3.7 |
| [m] addMetric | 1 | 1 | 4 | 4 |
| [m] addMetricSet | 1 | 1 | 4 | 4 |
| [m] getMetrics | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.metricset.DefaultMetricSet | 1 | 1.0 | 3 | 3.0 |
| [m] getMetrics | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.metricset.GroovyDslMetricSet | 2 | 1.0 | 21 | 10.5 |
| [m] getMetrics | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 18 | 18 |
| [c] org.gmetrics.metricset.ListMetricSet | 2 | 1.0 | 10 | 5.0 |
| [m] getMetrics | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 7 | 7 |
| [c] org.gmetrics.metricset.MetricSet | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.metricset.MetricSetBuilder | 2 | 1.0 | 7 | 3.5 |
| [m] metricset | 1 | 1 | 4 | 4 |
| [m] getMetricSet | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.metricset.TopLevelDelegate | 14 | 1.2 | 70 | 5.8 |
| [m] metricset | 1 | 1 | 4 | 4 |
| [m] metricset | 1 | 1 | 10 | 10 |
| [m] metric | 1 | 1 | 5 | 5 |
| [m] metric | 1 | 1 | 6 | 6 |
| [m] metric | 1 | 1 | 10 | 10 |
| [m] propertyMissing | 1 | 1 | 5 | 5 |
| [m] methodMissing | 2 | 2 | 10 | 10 |
| [m] description | 1 | 1 | 4 | 4 |
| [m] getMetricSet | 1 | 1 | 3 | 3 |
| [m] assertClassImplementsMetricInterface | 1 | 1 | 4 | 4 |
| [m] addMetric | 2 | 2 | 6 | 6 |
| [m] isNotWithinAnotherMetricDefinition | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.metricset.MetricSetDelegate | 4 | 1.3 | 21 | 7.0 |
| [m] methodMissing | 2 | 2 | 15 | 15 |
| [m] findMetric | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 3 | 3 |
| [p] org/gmetrics/report | 132 | 1.6 | 648 | 8.0 |
| [c] org.gmetrics.report.AbstractMetricCriteriaFilter | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.report.AbstractReportWriter | 20 | 1.7 | 76 | 6.3 |
| [m] writeReport | 2 | 2 | 14 | 14 |
| [m] writeReportToStandardOut | 1 | 1 | 4 | 4 |
| [m] writeReportToFile | 2 | 2 | 8 | 8 |
| [m] initializeDefaultResourceBundle | 2 | 2 | 12 | 12 |
| [m] getResourceBundleString | 2 | 2 | 9 | 9 |
| [m] getResourceBundleStringOrNull | 2 | 2 | 9 | 9 |
| [m] initializeFormatters | 2 | 2 | 7 | 7 |
| [m] formatMetricResultValue | 2 | 2 | 4 | 4 |
| [m] getFormattedTimestamp | 1 | 1 | 4 | 4 |
| [m] isWriteToStandardOut | 2 | 2 | 3 | 3 |
| [m] initializeResourceBundle | 1 | 1 | 1 | 1 |
| [m] getTimestamp | 1 | 1 | 1 | 1 |
| [c] org.gmetrics.report.BasicHtmlReportWriter | 27 | 1.8 | 168 | 11.2 |
| [m] writeReport | 1 | 1 | 17 | 17 |
| [m] buildMetricResultColumns | 2 | 2 | 11 | 11 |
| [m] buildCSS | 1 | 1 | 8 | 8 |
| [m] buildHeaderSection | 1 | 1 | 8 | 8 |
| [m] buildBodySection | 1 | 1 | 11 | 11 |
| [m] buildReportTimestamp | 1 | 1 | 6 | 6 |
| [m] buildResultsTable | 2 | 2 | 17 | 17 |
| [m] getMetricResultColumnHeading | 1 | 1 | 4 | 4 |
| [m] buildResultsTableRowRecursively | 8 | 8 | 30 | 30 |
| [m] buildResultsRowForLevel | 2 | 2 | 9 | 9 |
| [m] prefixForResultsNodeLevel | 1 | 1 | 8 | 8 |
| [m] buildMetricDescriptions | 2 | 2 | 24 | 24 |
| [m] getDescriptionForMetricName | 1 | 1 | 4 | 4 |
| [m] buildVersionFooter | 1 | 1 | 8 | 8 |
| [m] buildTitle | 2 | 2 | 3 | 3 |
| [c] org.gmetrics.report.FunctionsCriteriaFilter | 2 | 1.0 | 6 | 3.0 |
| [m] setFunctions | 1 | 1 | 3 | 3 |
| [m] includesFunction | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.report.LevelsCriteriaFilter | 2 | 1.0 | 6 | 3.0 |
| [m] setLevels | 1 | 1 | 3 | 3 |
| [m] includesLevel | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.report.MetricCriteriaFilterHelper | 6 | 1.5 | 23 | 5.8 |
| [m] includesName | 3 | 3 | 7 | 7 |
| [m] parseCriteria | 1 | 1 | 7 | 7 |
| [m] parseCriteriaForSingleMetric | 1 | 1 | 6 | 6 |
| [m] parseCommaSeparatedList | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.report.MetricsCriteriaFilter | 3 | 1.5 | 6 | 3.0 |
| [m] setMetrics | 1 | 1 | 3 | 3 |
| [m] includesMetric | 2 | 2 | 3 | 3 |
| [c] org.gmetrics.report.ReportWriter | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.report.SeriesValue | 2 | 1.0 | 7 | 3.5 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 4 | 4 |
| [c] org.gmetrics.report.SingleSeriesCriteriaFilter | 33 | 1.9 | 131 | 7.7 |
| [m] buildSeriesData | 1 | 1 | 20 | 20 |
| [m] findMatchingValuesForChildren | 1 | 1 | 6 | 6 |
| [m] getResultsNodeFullName | 3 | 3 | 14 | 14 |
| [m] findMatchingValues | 4 | 4 | 15 | 15 |
| [m] sortValuesIfApplicable | 3 | 3 | 9 | 9 |
| [m] limitToGreaterThanIfApplicable | 2 | 2 | 7 | 7 |
| [m] limitToLessThanIfApplicable | 2 | 2 | 7 | 7 |
| [m] limitToMaxResultsIfApplicable | 3 | 3 | 9 | 9 |
| [m] assertMetricExists | 1 | 1 | 4 | 4 |
| [m] assertLevelExists | 1 | 1 | 3 | 3 |
| [m] assertFunctionExists | 1 | 1 | 4 | 4 |
| [m] assertValidSortValue | 2 | 2 | 3 | 3 |
| [m] assertValidMaxResultsValue | 3 | 3 | 11 | 11 |
| [m] assertValidGreaterThanValue | 1 | 1 | 3 | 3 |
| [m] assertValidLessThanValue | 1 | 1 | 3 | 3 |
| [m] assertValidNumberValue | 3 | 3 | 10 | 10 |
| [m] findMetric | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.report.SingleSeriesHtmlReportWriter | 11 | 1.1 | 96 | 9.6 |
| [m] writeReport | 1 | 1 | 18 | 18 |
| [m] buildHeaderSection | 1 | 1 | 8 | 8 |
| [m] buildCSS | 1 | 1 | 8 | 8 |
| [m] buildBodySection | 2 | 2 | 13 | 13 |
| [m] buildReportTimestamp | 1 | 1 | 6 | 6 |
| [m] buildResultsTable | 1 | 1 | 13 | 13 |
| [m] getSeriesValueNameHeading | 1 | 1 | 9 | 9 |
| [m] buildSeriesValueRow | 1 | 1 | 9 | 9 |
| [m] getMetricResultColumnHeading | 1 | 1 | 4 | 4 |
| [m] buildVersionFooter | 1 | 1 | 8 | 8 |
| [c] org.gmetrics.report.XmlReportWriter | 26 | 1.7 | 129 | 8.6 |
| [m] writeReport | 1 | 1 | 17 | 17 |
| [m] buildReportElement | 1 | 1 | 5 | 5 |
| [m] buildProjectElement | 1 | 1 | 9 | 9 |
| [m] buildPackageElements | 1 | 1 | 3 | 3 |
| [m] buildElement | 4 | 4 | 7 | 7 |
| [m] buildPackageElement | 5 | 5 | 20 | 20 |
| [m] buildClassElement | 1 | 1 | 10 | 10 |
| [m] buildMethodElement | 1 | 1 | 10 | 10 |
| [m] buildMetricElements | 1 | 1 | 7 | 7 |
| [m] buildMetricElement | 5 | 5 | 14 | 14 |
| [m] isRoot | 1 | 1 | 3 | 3 |
| [m] buildMetricsElement | 1 | 1 | 14 | 14 |
| [m] getDescriptionForMetric | 1 | 1 | 4 | 4 |
| [m] isPackage | 1 | 1 | 3 | 3 |
| [m] cdata | 1 | 1 | 3 | 3 |
| [p] org/gmetrics/result | 39 | 1.5 | 125 | 4.8 |
| [c] org.gmetrics.result.ClassMetricResult | 2 | 1.0 | 7 | 3.5 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 4 | 4 |
| [c] org.gmetrics.result.FunctionNames | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.result.MethodKey | 6 | 1.2 | 23 | 4.6 |
| [m] equals | 2 | 2 | 4 | 4 |
| [m] hashCode | 1 | 1 | 4 | 4 |
| [m] toString | 1 | 1 | 4 | 4 |
| [m] <init> | 1 | 1 | 5 | 5 |
| [m] <init> | 1 | 1 | 6 | 6 |
| [c] org.gmetrics.result.MetricResult | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.result.MetricResultBuilder | 23 | 1.8 | 64 | 4.9 |
| [m] createAggregateMetricResult | 1 | 1 | 13 | 13 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] calculateFunctions | 1 | 1 | 10 | 10 |
| [m] calculateCount | 1 | 1 | 3 | 3 |
| [m] total | 2 | 2 | 3 | 3 |
| [m] calculateTotal | 2 | 2 | 5 | 5 |
| [m] minimum | 2 | 2 | 3 | 3 |
| [m] calculateMinimum | 2 | 2 | 4 | 4 |
| [m] maximum | 2 | 2 | 3 | 3 |
| [m] calculateMaximum | 2 | 2 | 4 | 4 |
| [m] average | 2 | 2 | 3 | 3 |
| [m] calculateAverage | 3 | 3 | 7 | 7 |
| [m] shouldCalculateFunction | 2 | 2 | 3 | 3 |
| [c] org.gmetrics.result.NumberMetricResult | 4 | 1.3 | 16 | 5.3 |
| [m] getAt | 2 | 2 | 3 | 3 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 10 | 10 |
| [c] org.gmetrics.result.SingleNumberMetricResult | 4 | 1.3 | 15 | 5.0 |
| [m] getAt | 2 | 2 | 3 | 3 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 9 | 9 |
| [p] org/gmetrics/resultsnode | 27 | 1.2 | 99 | 4.5 |
| [c] org.gmetrics.resultsnode.ClassResultsNode | 8 | 1.3 | 29 | 4.8 |
| [m] containsClassResults | 1 | 1 | 3 | 3 |
| [m] getMetricResult | 1 | 1 | 4 | 4 |
| [m] addClassMetricResult | 2 | 2 | 10 | 10 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] addMethodMetricResult | 2 | 2 | 6 | 6 |
| [m] <init> | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.resultsnode.MethodResultsNode | 7 | 1.0 | 24 | 3.4 |
| [m] containsClassResults | 1 | 1 | 3 | 3 |
| [m] getMetricResult | 1 | 1 | 4 | 4 |
| [m] addMetricResult | 1 | 1 | 4 | 4 |
| [m] getChildren | 1 | 1 | 3 | 3 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 4 | 4 |
| [c] org.gmetrics.resultsnode.PackageResultsNode | 12 | 1.3 | 46 | 5.1 |
| [m] getChildren | 1 | 1 | 3 | 3 |
| [m] containsClassResults | 1 | 1 | 3 | 3 |
| [m] getMetricResult | 1 | 1 | 4 | 4 |
| [m] addChildIfNotEmpty | 2 | 2 | 7 | 7 |
| [m] addChild | 1 | 1 | 5 | 5 |
| [m] applyMetric | 3 | 3 | 14 | 14 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 4 | 4 |
| [c] org.gmetrics.resultsnode.ResultsNode | N/A | N/A | N/A | N/A |
| [p] org/gmetrics/source | 37 | 2.1 | 111 | 6.2 |
| [c] org.gmetrics.source.AbstractSourceCode | 16 | 2.7 | 51 | 8.5 |
| [m] getLines | 2 | 2 | 6 | 6 |
| [m] line | 3 | 3 | 5 | 5 |
| [m] getAst | 3 | 3 | 16 | 16 |
| [m] getLineNumberForCharacterIndex | 5 | 5 | 16 | 16 |
| [m] isValid | 1 | 1 | 3 | 3 |
| [m] normalizePath | 2 | 2 | 5 | 5 |
| [c] org.gmetrics.source.SourceCode | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.source.SourceCodeCriteria | 8 | 8.0 | 17 | 17.0 |
| [m] matches | 8 | 8 | 17 | 17 |
| [c] org.gmetrics.source.SourceFile | 7 | 1.2 | 25 | 4.2 |
| [m] getName | 1 | 1 | 3 | 3 |
| [m] getPath | 1 | 1 | 3 | 3 |
| [m] getText | 2 | 2 | 6 | 6 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] createSourceUnit | 1 | 1 | 5 | 5 |
| [m] <init> | 1 | 1 | 5 | 5 |
| [c] org.gmetrics.source.SourceString | 6 | 1.2 | 18 | 3.6 |
| [m] getText | 1 | 1 | 3 | 3 |
| [m] setPath | 2 | 2 | 3 | 3 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] createSourceUnit | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 6 | 6 |
| [p] org/gmetrics/util | 81 | 2.4 | 233 | 6.9 |
| [c] org.gmetrics.util.AstUtil | 38 | 2.5 | 94 | 6.3 |
| [m] isEmptyMethod | 1 | 1 | 3 | 3 |
| [m] isClosureField | 2 | 2 | 3 | 3 |
| [m] isBlock | 1 | 1 | 3 | 3 |
| [m] isEmptyBlock | 4 | 4 | 5 | 5 |
| [m] getMethodArguments | 3 | 3 | 10 | 10 |
| [m] isMethodCall | 3 | 3 | 10 | 10 |
| [m] isMethodCall | 2 | 2 | 4 | 4 |
| [m] isMethodCall | 3 | 3 | 9 | 9 |
| [m] isMethodNamed | 1 | 1 | 4 | 4 |
| [m] getAnnotation | 2 | 2 | 6 | 6 |
| [m] getVariableExpressions | 9 | 9 | 16 | 16 |
| [m] isFinalVariable | 4 | 4 | 14 | 14 |
| [m] isFromGeneratedSourceCode | 1 | 1 | 3 | 3 |
| [m] respondsTo | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 1 | 1 |
| [c] org.gmetrics.util.GMetricsVersion | 1 | 1.0 | 3 | 3.0 |
| [m] getVersion | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.util.PathUtil | 13 | 2.6 | 33 | 6.6 |
| [m] getName | 3 | 3 | 7 | 7 |
| [m] getParent | 3 | 3 | 9 | 9 |
| [m] normalize | 2 | 2 | 3 | 3 |
| [m] toPackageName | 4 | 4 | 13 | 13 |
| [m] <init> | 1 | 1 | 1 | 1 |
| [c] org.gmetrics.util.PropertyUtil | 6 | 3.0 | 23 | 11.5 |
| [m] setPropertyFromString | 5 | 5 | 22 | 22 |
| [m] <init> | 1 | 1 | 1 | 1 |
| [c] org.gmetrics.util.WildcardPattern | 13 | 3.3 | 46 | 11.5 |
| [m] matches | 4 | 4 | 7 | 7 |
| [m] containsWildcards | 1 | 1 | 3 | 3 |
| [m] convertStringWithWildcardsToRegex | 5 | 5 | 24 | 24 |
| [m] <init> | 3 | 3 | 12 | 12 |
| [p] org/gmetrics/util/io | 10 | 1.4 | 34 | 4.9 |
| [c] org.gmetrics.util.io.ClassPathResource | 4 | 1.3 | 14 | 4.7 |
| [m] getInputStream | 1 | 1 | 3 | 3 |
| [m] getInputStream | 2 | 2 | 7 | 7 |
| [m] <init> | 1 | 1 | 4 | 4 |
| [c] org.gmetrics.util.io.DefaultResourceFactory | 4 | 2.0 | 12 | 6.0 |
| [m] getResource | 3 | 3 | 9 | 9 |
| [m] isUrl | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.util.io.Resource | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.util.io.ResourceFactory | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.util.io.UrlResource | 2 | 1.0 | 8 | 4.0 |
| [m] getInputStream | 1 | 1 | 4 | 4 |
| [m] <init> | 1 | 1 | 4 | 4 |
| # | Metric Name | Description |
|---|---|---|
| 1 | CyclomaticComplexity | Measures the (McCabe) Cyclomatic Complexity of source code. See the Wikipedia entry for Cyclomatic Complexity. |
| 2 | MethodLineCount | Counts the number of lines in each method. |
| Method | Method Lines (total) |
|---|---|
| org.gmetrics.report.BasicHtmlReportWriter#buildResultsTableRowRecursively | 30 |
| org.gmetrics.metric.crap.CrapMetric#calculate | 24 |
| org.gmetrics.report.BasicHtmlReportWriter#buildMetricDescriptions | 24 |
| org.gmetrics.util.WildcardPattern#convertStringWithWildcardsToRegex | 24 |
| org.gmetrics.util.PropertyUtil#setPropertyFromString | 22 |
| org.gmetrics.metric.coverage.AbstractCoberturaCoverageMetric#calculateForClass | 21 |
| org.gmetrics.report.SingleSeriesCriteriaFilter#buildSeriesData | 20 |
| org.gmetrics.report.XmlReportWriter#buildPackageElement | 20 |
| org.gmetrics.GMetricsRunner#execute | 19 |
| org.gmetrics.analyzer.FilesystemSourceAnalyzer#processDirectory | 19 |
| org.gmetrics.metricset.GroovyDslMetricSet#<init> | 18 |
| org.gmetrics.report.SingleSeriesHtmlReportWriter#writeReport | 18 |
| org.gmetrics.metric.abc.result.AggregateAbcMetricResult#calculateFunctions | 17 |
| org.gmetrics.metric.coverage.AbstractCoberturaCoverageMetric#calculateForPackage | 17 |
| org.gmetrics.report.BasicHtmlReportWriter#writeReport | 17 |
| org.gmetrics.report.BasicHtmlReportWriter#buildResultsTable | 17 |
| org.gmetrics.report.XmlReportWriter#writeReport | 17 |
| org.gmetrics.source.SourceCodeCriteria#matches | 17 |
| org.gmetrics.ant.AntFileSetSourceAnalyzer#processFile | 16 |
| org.gmetrics.metric.AbstractMethodMetric#calculateForClass | 16 |