Groovy Documentation

org.gmetrics.result
Interface MetricResult


interface MetricResult

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

author:
Chris Mair
version:
$Revision: 130 $ - $Date: 2010-07-21 22:46:24 -0400 (Wed, 21 Jul 2010) $


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()

 

Method Detail

getAt

Object getAt(String propertyName)
Return the metric result value for the named function (e.g. "average", "total")
param:
propertyName - the function name
return:
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).
return:
the count of metric result children


getLineNumber

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


getMetric

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


 

Groovy Documentation