- AbcAstVisitor - Class in org.gmetrics.metric.abc
AST Visitor for calculating the ABC Metric for a class/method.
- AbcMetric - Class in org.gmetrics.metric.abc
Calculate the ABC Metric for a class/method.
- AbcMetricResult - Class in org.gmetrics.metric.abc.result
A MetricResult specifically for the ABC metric
- AbcMetricResult(Metric, MetricLevel, AbcVector, Integer) - Constructor in AbcMetricResult
-
- AbcVector - Class in org.gmetrics.metric.abc
Represents a single ABC Metric result: a vector of the three A, B, C values.
- AbcVector(int, int, int) - Constructor in AbcVector
-
- AbstractAstVisitor - Class in org.gmetrics.metric
Abstract superclass for Groovy AST Visitors
- AbstractCoberturaCoverageMetric - Class in org.gmetrics.metric.coverage
Abstract superclass for metrics that provide test code coverage from a Cobertura XML file.
- AbstractCouplingReferenceManager - Class in org.gmetrics.metric.coupling
Abstract superclass for Afferent/efferent coupling reference manager classes.
- AbstractCouplingReferenceManager(Metric) - Constructor in AbstractCouplingReferenceManager
-
- AbstractMethodMetric - Class in org.gmetrics.metric
Abstract superclass for method-based metrics.
- AbstractMetric - Class in org.gmetrics.metric
Abstract superclass for metrics.
- AbstractMetricCriteriaFilter - Class in org.gmetrics.report
- AbstractPackageCouplingMetric - Class in org.gmetrics.metric.coupling
Abstract superclass for Metrics that measure package-level coupling.
- AbstractPackageCouplingMetric() - Constructor in AbstractPackageCouplingMetric
-
- AbstractReportWriter - Class in org.gmetrics.report
Abstract superclass for ReportWriter implementation classes.
- AbstractSourceCode - Class in org.gmetrics.source
Abstract superclass for SourceCode implementations
- addChild(String, ResultsNode) - Method in PackageResultsNode
-
- addChildIfNotEmpty(String, ResultsNode) - Method in PackageResultsNode
-
- addClassMetricResult(ClassMetricResult) - Method in ClassResultsNode
-
- addConfiguredOption(ReportOption) - Method in Report
-
- addConfiguredReport(Report) - Method in GMetricsTask
-
Ant-defined method (by convention), called with each instance of a nested
element within this task.
- addFileset(FileSet) - Method in GMetricsTask
-
Ant-defined method (by convention), called with each instance of a nested
element within this task.
- addMetric(Metric) - Method in CompositeMetricSet
-
Add a single Metric to this MetricSet
- addMetricResult(MetricResult) - Method in MethodResultsNode
-
- addMetricSet(MetricSet) - Method in CompositeMetricSet
-
Add all of the Metrics within the specified MetricSet to this MetricSet
- addReferencesFromPackage(String, Collection<String>) - Method in AbstractCouplingReferenceManager
-
- AfferentCouplingMetric - Class in org.gmetrics.metric.coupling
Metric for counting the number of other packages that depend on the classes within this package.
- AfferentCouplingReferenceManager - Class in org.gmetrics.metric.coupling
Maintains a mapping of packageName -> packages that reference it, as well as a reference
to a MetricResult for the associated PackageResultsNode.
- AfferentCouplingReferenceManager(Metric) - Constructor in AfferentCouplingReferenceManager
-
- afterAllSourceCodeProcessed() - Method in AfferentCouplingMetric
-
- afterAllSourceCodeProcessed() - Method in EfferentCouplingMetric
-
- afterAllSourceCodeProcessed() - Method in PostProcessingMetric
-
- AggregateAbcMetricResult - Class in org.gmetrics.metric.abc.result
An aggregate MetricResult implementation specifically for the ABC Metric.
- AggregateAbcMetricResult(Metric, MetricLevel, Collection, Integer) - Constructor in AggregateAbcMetricResult
-
- AnalysisContext - Class in org.gmetrics.analyzer
Holds information related to the configuration and context for the source code analysis.
- analyze(MetricSet) - Method in AntFileSetSourceAnalyzer
-
Analyze all source code using the specified MetricSet and return the results node.
- analyze(MetricSet) - Method in SourceAnalyzer
-
Analyze all source code using the specified set of Metrics and return the results.
- AntFileSetSourceAnalyzer - Class in org.gmetrics.ant
SourceAnalyzer implementation that gets source files from one or more Ant FileSets.
- AntFileSetSourceAnalyzer(Project, List) - Constructor in AntFileSetSourceAnalyzer
-
Construct a new instance on the specified List of Ant FileSets.
- applyMetric(Metric) - Method in PackageResultsNode
-
- applyToClass(ClassNode, SourceCode) - Method in AbstractMetric
-
- applyToClass(ClassNode, SourceCode) - Method in Metric
-
- applyToClosure(ClosureExpression, SourceCode) - Method in AbstractCoberturaCoverageMetric
-
- applyToClosure(ClosureExpression, SourceCode) - Method in AbstractMethodMetric
-
- applyToClosure(ClosureExpression, SourceCode) - Method in MethodMetric
-
- applyToMethod(MethodNode, SourceCode) - Method in AbstractCoberturaCoverageMetric
-
- applyToMethod(MethodNode, SourceCode) - Method in AbstractMethodMetric
-
- applyToMethod(MethodNode, SourceCode) - Method in MethodMetric
-
- applyToPackage(String, String, Collection<MetricResult>) - Method in AbstractMetric
-
- applyToPackage(String, String, Collection<MetricResult>) - Method in Metric
-
- AstUtil - Class in org.gmetrics.util
Contains static utility methods related to Groovy AST.
- AstVisitor - Interface in org.gmetrics.metric
Interface for Groovy AST Visitors
- asType(Class) - Method in Ratio
-
- AVERAGE - Field in FunctionNames
-
- getAbcVector() - Method in AggregateAbcMetricResult
-
- getAllMetricNames() - Method in DefaultMetricRegistry
-
- getAllMetricNames() - Method in MetricRegistry
-
- getAnnotation(AnnotatedNode, String) - Method in AstUtil
-
Return the AnnotationNode for the named annotation, or else null.
- getAst() - Method in AbstractSourceCode
-
Return the Groovy AST (Abstract Syntax Tree) for this source file
- getAst() - Method in SourceCode
-
Return the Groovy AST (Abstract Syntax Tree) for this source file
- getAt(String) - Method in AbcMetricResult
-
- getAt(String) - Method in AggregateAbcMetricResult
-
- getAt(String) - Method in MapMetricResult
-
- getAt(String) - Method in MetricResult
-
Return the metric result value for the named function (e.g.
- getAt(String) - Method in MutableMapMetricResult
-
- getAt(String) - Method in NumberMetricResult
-
- getAt(String) - Method in SingleNumberMetricResult
-
- getAttributeName() - Method in AbstractCoberturaCoverageMetric
-
- Returns:
- the name of the desired coverage attribute within the Cobertura XML file (e.g.
- getAverageAbcVector() - Method in AggregateAbcMetricResult
-
Return the average of this set of ABC vectors.
- getBaseLevel() - Method in Metric
-
- getChildren() - Method in MethodResultsNode
-
- getChildren() - Method in PackageResultsNode
-
- getChildren() - Method in ResultsNode
-
- getCoberturaXml() - Method in CoberturaCoverageFile
-
- getCount() - Method in AggregateAbcMetricResult
-
- getCount() - Method in MetricResult
-
Return the count of the nodes/results that are descendants.
- getCoverageRatioForClass(String) - Method in AbstractCoberturaCoverageMetric
-
- getCoverageRatioForSingleClass(def) - Method in AbstractCoberturaCoverageMetric
-
@return the calculated coverage ratio for the Cobertura XML class element
- getCoverageRatioForSingleClass(def) - Method in CoberturaBranchCoverageMetric
-
- getCoverageRatioForSingleClass(def) - Method in CoberturaLineCoverageMetric
-
- getDescriptionForMetric(Metric) - Method in XmlReportWriter
-
- getDescriptionForMetricName(String) - Method in BasicHtmlReportWriter
-
- getFormattedTimestamp() - Method in AbstractReportWriter
-
- getFormatter(String) - Method in FormatterFactory
-
Create and return a Formatter instance based on a specification String, which is the class name.
- getFunctions() - Method in Metric
-
- getInputStream() - Method in ClassPathResource
-
Open an InputStream on the classpath resource path
- getInputStream() - Method in Resource
-
Return the InputStream for this resource.
- getInputStream() - Method in UrlResource
-
Open a FileInputStream on the file
- getLevel() - Method in ResultsNode
-
- getLineNumber() - Method in MetricResult
-
Return the line number associated with this metric result (i.e., method or class)
- getLineNumberForCharacterIndex(int) - Method in AbstractSourceCode
-
Return the line index for the line containing the character at the specified index within the source code.
- getLineNumberForCharacterIndex(int) - Method in SourceCode
-
Return the line index for the line containing the character at the specified index within the source code.
- getLines() - Method in AbstractSourceCode
-
@return the List of lines of the source code (with line terminators removed)
- getLines() - Method in SourceCode
-
@return the List of lines of the source code (with line terminators removed)
- getMagnitude() - Method in AbcVector
-
Return the magnitude of this ABC vector, specifically:
|ABC| = sqrt((A*A)+(B*B)+(C*C))
- getMethodArguments(MethodCallExpression) - Method in AstUtil
-
Return the List of Arguments for the specified MethodCallExpression.
- getMetric() - Method in MetricResult
-
@return the Metric for which this object represents results.
- getMetricClass(String) - Method in DefaultMetricRegistry
-
- getMetricClass(String) - Method in MetricRegistry
-
- getMetricLevel() - Method in MetricResult
-
@return the MetricLevel for this metric result
- getMetricResult(String) - Method in AfferentCouplingMetric
-
- getMetricResult(Metric) - Method in ClassResultsNode
-
- getMetricResult(String) - Method in EfferentCouplingMetric
-
- getMetricResult(Metric) - Method in MethodResultsNode
-
- getMetricResult(Metric) - Method in PackageResultsNode
-
- getMetricResult(Metric) - Method in ResultsNode
-
- getMetricResults() - Method in ResultsNode
-
- getMetrics() - Method in CompositeMetricSet
-
- Returns:
- a List of Metric objects.
- getMetrics() - Method in DefaultMetricSet
-
- getMetrics() - Method in GroovyDslMetricSet
-
@return a List of Metric objects
- getMetrics() - Method in ListMetricSet
-
@return a List of Metric objects
- getMetrics() - Method in MetricSet
-
- getMetricSet() - Method in MetricSetBuilder
-
- getMetricSet() - Method in TopLevelDelegate
-
- getName() - Method in Metric
-
- getName(String) - Method in PathUtil
-
- getName() - Method in ResultsNode
-
- getName() - Method in SourceCode
-
Get the logical name for this source code.
- getName() - Method in SourceFile
-
@return the filename for this source file, excluding path
- getNames() - Method in MetricLevel
-
- getNumberOfFields() - Method in FieldCountAstVisitor
-
- getNumberOfMethods() - Method in MethodCountAstVisitor
-
- getOverallCoverageRate() - Method in CoberturaCoverageFile
-
- getPackageMetricResult(String) - Method in AbstractCouplingReferenceManager
-
- getParent(String) - Method in PathUtil
-
- getPath() - Method in SourceCode
-
Get the logical path for this source code.
- getPath() - Method in SourceFile
-
@return the normalized path for this source file, including filename
- getReferencesFromPackage(String) - Method in AbstractCouplingReferenceManager
-
- getResource(String) - Method in DefaultResourceFactory
-
Return a Resource instance suitable for the specified path.
- getResource(String) - Method in ResourceFactory
-
Return a Resource instance suitable for the specified path.
- getResourceBundleString(String, String) - Method in AbstractReportWriter
-
- getResourceBundleStringOrNull(String) - Method in AbstractReportWriter
-
- getSourceDirectories() - Method in AntFileSetSourceAnalyzer
-
- getSourceDirectories() - Method in SourceAnalyzer
-
Return the List of source directories to be analyzed.
- getSourceUnit() - Method in AbstractAstVisitor
-
- getText() - Method in SourceCode
-
@return the full text of the source code
- getText() - Method in SourceFile
-
@return the full text of the source code
- getText() - Method in SourceString
-
@return the full text of the source code
- getTimestamp - Field in AbstractReportWriter
-
- getTotalAbcVector() - Method in AggregateAbcMetricResult
-
Return the sum of this set of ABC vectors.
- getVariableExpressions(DeclarationExpression) - Method in AstUtil
-
Return the List of VariableExpression objects referenced by the specified DeclarationExpression.
- getVersion() - Method in GMetricsVersion
-
- GMETRICS_URL - Field in AbstractReportWriter
-
- GMetricsRunner - Class in org.gmetrics
Helper class to run GMetrics.
- GMetricsTask - Class in org.gmetrics.ant
Ant Task for GMetrics.
- GMetricsVersion - Class in org.gmetrics.util
Utility class to return the current GMetrics version number.
- GroovyDslMetricSet - Class in org.gmetrics.metricset
A MetricSet
implementation that parses a Groovy DSL of Metric definitions.
- GroovyDslMetricSet(String) - Constructor in GroovyDslMetricSet
-
Construct a new instance on the specified Groovy DSL MetricSet file path
- MapMetricResult - Class in org.gmetrics.result
A MetricResult for arbitrary values, backed by a Map.
- MapMetricResult(Metric, MetricLevel, Map<String, Object>, int) - Constructor in MapMetricResult
-
Construct a new instance
- matches(SourceCode) - Method in SourceCodeCriteria
-
Return true if all of the criteria specified in this object apply to thw SourceCode.
- matches(String) - Method in WildcardPattern
-
Return true if the specified String matches the pattern or if the original
patternString (specified in the constructor) was null or empty and the
value for defaultMatches (also specified in the constructor) was true.
- matchesCoberturaMethod(String, String, String, String) - Method in CoberturaSignatureParser
-
- MAX_SOURCE_LINE_LENGTH - Field in AbstractAstVisitor
-
- MAXIMUM - Field in FunctionNames
-
- MethodCountAstVisitor - Class in org.gmetrics.metric.methodcount
AstVisitor for the MethodCountMetric.
- MethodCountMetric - Class in org.gmetrics.metric.methodcount
Metric for counting the number of methods within classes and interfaces.
- MethodKey - Class in org.gmetrics.result
Serves as a key in the Map of method --> MetricResult.
- MethodKey(MethodNode) - Constructor in MethodKey
-
- MethodLineCountAstVisitor - Class in org.gmetrics.metric.linecount
AST Visitor for calculating the lines of code for a method or closure field.
- MethodLineCountMetric - Class in org.gmetrics.metric.linecount
Metric for counting the lines of code for methods and closure fields.
- MethodMetric - Interface in org.gmetrics.metric
Represents a method-level metric
- methodMissing(String, def) - Method in MetricSetDelegate
-
- methodMissing(String, def) - Method in TopLevelDelegate
-
- MethodResultsNode - Class in org.gmetrics.resultsnode
Represents a method result node in the hierarchy of metric result nodes
- MethodResultsNode(String, String) - Constructor in MethodResultsNode
-
- Metric - Interface in org.gmetrics.metric
Represents a metric
- METRIC_CLASSES - Field in DefaultMetricRegistry
-
- metric(Class, Closure) - Method in TopLevelDelegate
-
- MetricCriteriaFilterHelper - Class in org.gmetrics.report
Provides common static helper methods for classes that provides data and behavior for enabling reports
to filter the results included within a report based a filter map keyed on the metric name.
- MetricLevel - Enum in org.gmetrics.metric
Enum representing the level at which a metric is applied - either method, class or package
- MetricRegistry - Interface in org.gmetrics.metricregistry
Represents a registry of metric classes, accessible by metric name
- MetricRegistryHolder - Class in org.gmetrics.metricregistry
Holds a reference to the MetricRegistry static singleton
- MetricResult - Interface in org.gmetrics.result
Represents the result from applying a single metric (to a package, class or method)
- MetricResultBuilder - Class in org.gmetrics.result
A Builder for MetricResult objects.
- metricResultMap - Field in AbstractCouplingReferenceManager
-
- MetricsCriteriaFilter - Class in org.gmetrics.report
Provides data and behavior for enabling reports to filter the set of metrics included in a report.
- MetricSet - Interface in org.gmetrics.metricset
Represents a set of (configured) Metric objects
- metricset(Closure) - Method in MetricSetBuilder
-
- metricset(String, Closure) - Method in TopLevelDelegate
-
- MetricSetBuilder - Class in org.gmetrics.metricset
A Builder for MetricSets.
- MetricSetDelegate - Class in org.gmetrics.metricset
- MetricSetDelegate(MetricSet) - Constructor in MetricSetDelegate
-
- MINIMUM - Field in FunctionNames
-
- MutableMapMetricResult - Class in org.gmetrics.result
A MetricResult for arbitrary values, backed by a mutable Map.
- MutableMapMetricResult(Metric, MetricLevel, Map<String, Object>) - Constructor in MutableMapMetricResult
-
Construct a new instance
- SCALE - Field in AbstractCoberturaCoverageMetric
-
- SeriesValue - Class in org.gmetrics.report
Holder for a single data item within a series
- SeriesValue(String, Object) - Constructor in SeriesValue
-
- setFunctions(String) - Method in FunctionsCriteriaFilter
-
- setLevels(String) - Method in LevelsCriteriaFilter
-
- setMetrics(String) - Method in MetricsCriteriaFilter
-
- setPath(String) - Method in SourceString
-
- setPropertyFromString(Object, String, String) - Method in PropertyUtil
-
Set the value of the named property on the specified Object from a String value.
- setReportLevels(String) - Method in BasicHtmlReportWriter
-
- setSourceCode(SourceCode) - Method in AstVisitor
-
Set the SourceCode associated with this visitor
- SingleNumberMetricResult - Class in org.gmetrics.result
A MetricResult for numbers (integers, BigDecimals, etc.), that returns the same, single value for
total, average, minimum and maximum.
- SingleNumberMetricResult(Metric, MetricLevel, def, Integer) - Constructor in SingleNumberMetricResult
-
Construct a new instance
- SingleSeriesCriteriaFilter - Class in org.gmetrics.report
Provides data and behavior for enabling reports to filter the results based on a single
metric, single level and single function to provide a single series of data.
- SingleSeriesHtmlReportWriter - Class in org.gmetrics.report
ReportWriter that generates a HTML report for a single series of metric values.
- sortPackagesWithReferencesWithParentFirst() - Method in AbstractCouplingReferenceManager
-
- SOURCE_LINE_LAST_SEGMENT_LENGTH - Field in AbstractAstVisitor
-
- SourceAnalyzer - Interface in org.gmetrics.analyzer
The interface for objects that can analyze the source files within one or more directory
trees using a specified MetricSet and produce report results.
- SourceCode - Interface in org.gmetrics.source
Represents a unit of source code to be analyzed
- SourceCodeCriteria - Class in org.gmetrics.source
Represents the set of criteria used to filter source code (files).
- SourceFile - Class in org.gmetrics.source
The SourceCode implementation for a single file.
- SourceFile(File) - Constructor in SourceFile
-
Construct a new instance for the file at the specified path
- sourceLine(ASTNode) - Method in AbstractAstVisitor
-
Return the source line corresponding to the specified AST node
- SourceString - Class in org.gmetrics.source
SourceCode implementation that uses source from a pre-defined String.
- SourceString(String, String, String) - Constructor in SourceString
-
Construct a new instance for the file at the specified path