Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | PROPERTY | CONSTR | METHOD DETAIL: FIELD | PROPERTY | CONSTR | METHOD

org.gmetrics.result
[Groovy] Class MetricResultBuilder

java.lang.Object
  org.gmetrics.result.MetricResultBuilder

class MetricResultBuilder

A Builder for MetricResult objects.

Authors:
Chris Mair

Property Summary
Metric metric

MetricLevel metricLevel

int scale

 
Method Summary
MetricResult createAggregateMetricResult(Collection children, Integer lineNumber, Map overrideValues = null)

Calculate the aggregate metric results for the specified child metric results.

String toString()

 
Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Property Detail

metric

Metric metric

metricLevel

MetricLevel metricLevel

scale

int scale

 
Method Detail

createAggregateMetricResult

MetricResult createAggregateMetricResult(Collection children, Integer lineNumber, Map overrideValues = null)
Calculate the aggregate metric results for the specified child metric results. The metric and metricLevel properties of this object must be set before calling this method.
Parameters:
children - - the optional collection of results from children
lineNumber - - the line number for the source element (AST) that triggered this metric result; may be null
overrideValues - - the optional Map of functionName:resultValue to specify override values for the specified functions; may be null or empty to specify no predefined values
Returns:
a MetricResult for the calculated values

toString

String toString()

 

Groovy Documentation