Package org.apache.storm.metric.api

Class CombinedMetric

java.lang.Object

org.apache.storm.metric.api.CombinedMetric

All Implemented Interfaces:

IMetric

Direct Known Subclasses:

CombinedShellMetric

public class CombinedMetric
extends Object
implements IMetric

Constructor Summary

Constructors

Constructor	Description
CombinedMetric(ICombiner combiner)

Method Summary

Modifier and Type	Method	Description
Object	getValueAndReset()	Get value and reset.
void	update(Object value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CombinedMetric

public CombinedMetric(ICombiner combiner)

Method Details

update

public void update(Object value)

getValueAndReset

public Object getValueAndReset()

Description copied from interface: IMetric

Get value and reset.

Specified by:

getValueAndReset in interface IMetric

Returns:

an object that will be sent to IMetricsConsumer.handleDataPoints(org.apache.storm.metric.api.IMetricsConsumer.TaskInfo,java.util.Collection). If null is returned nothing will be sent. If this value can be reset, like with a counter, a side effect of calling this should be that the value is reset.