Groovy Documentation

org.gmetrics.result
[Groovy] Interface MetricResult


interface MetricResult

Represents the result from applying a single metric (to a package, class or method)

Authors:
Chris Mair
Version:
\$Revision: 163 \$ - \$Date: 2011-10-02 21:55:46 -0400 (Sun, 02 Oct 2011) \$


Method Summary
Object getAt(String propertyName)

Return the metric result value for the named function (e.g.

int getCount()

Return the count of the nodes/results that are descendants.

Integer getLineNumber()

Return the line number associated with this metric result (i.e., method or class)

Metric getMetric()

@return the Metric for which this object represents results.

MetricLevel getMetricLevel()

@return the MetricLevel for this metric result

 

Method Detail

getAt

Object getAt(String propertyName)
Return the metric result value for the named function (e.g. "average", "total")
Parameters:
propertyName - - the function name
Returns:
the named function value or null if that function is not supported


getCount

int getCount()
Return the count of the nodes/results that are descendants. For instance, if this result represents a class, then the count includes all of the method-level result children (if applicable for the metric).
Returns:
the count of metric result children


getLineNumber

Integer getLineNumber()
Return the line number associated with this metric result (i.e., method or class)
Returns:
an Integer; may be null


getMetric

Metric getMetric()
Returns:
the Metric for which this object represents results.


getMetricLevel

MetricLevel getMetricLevel()
Returns:
the MetricLevel for this metric result


 

Groovy Documentation