com.h3c.sdn.metric

Class TimeStampedGauge

java.lang.Object

com.h3c.sdn.metric.TimeStampedGauge

All Implemented Interfaces:

com.codahale.metrics.Gauge<Long>, com.codahale.metrics.Metric, TimeStampedMetric

public class TimeStampedGauge
extends Object
implements com.codahale.metrics.Gauge<Long>, TimeStampedMetric

Implementation of Coda Hale Gauge interface that provides an association of the Gauge value with time stamps.

Field Summary

Fields

Modifier and Type	Field and Description
static long	UNINITIALIZED

Constructor Summary

Constructors

Constructor and Description
TimeStampedGauge(MetricRegistry registry, GaugeDescriptor descriptor) Constructs a TimeStampedGauge with the specified characteristics using the specified MetricRegistry.
TimeStampedGauge(MetricRegistry registry, GaugeDescriptor descriptor, String uid) Constructs a TimeStampedGauge with the specified UID and other characteristics using the specified MetricRegistry.

Method Summary

Methods

Modifier and Type	Method and Description
GaugeDataPoint	extractDataPoint() Extract a GaugeDataPoint from this object.
GaugeDescriptor	getDescriptor() Gets the MetricDescriptor that describes this TimeStampedMetric object.
long	getMsSpanned() Determines the number of milliseconds spanned between the latest (update) time stamp and the oldest (previous) time stamp, accounting for roll-over of the time stamp.
long	getPreviousTimeStamp() Gets the previous time stamp.
protected TimeStampManager	getTimeStampManager() Gets the TimeStampManager that this object uses to manage its associated time stamps.
String	getUid() Gets the UID.
long	getUpdateTimeStamp() Gets the update time stamp.
Long	getValue()
void	reset() Prepares the gauge for use in a new time period by saving the most recent update time stamp as the previous time stamp.
void	setDescriptor(GaugeDescriptor toSet) Sets the GaugeDescriptor that specifies characteristics of this TimeStampedGauge.
void	setPreviousTimeStamp(long time) Sets the previous time stamp.
void	setUid(String toSet) Sets the UID of this object.
void	setUpdateTimeStamp(long time) Sets the update time stamp.
void	setValue(long toSet) Sets the value of this TimeStampedGauge.
String	toDebugString() Gets a detailed representation of this object to facilitate debugging.
String	toString()
void	updateTimeStamp() Convenience method that sets the update time stamp to the current time.

Methods inherited from class java.lang.Object

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

Field Detail

UNINITIALIZED

public static final long UNINITIALIZED

See Also:

Constant Field Values

Constructor Detail

TimeStampedGauge

public TimeStampedGauge(MetricRegistry registry,
                GaugeDescriptor descriptor)

Constructs a TimeStampedGauge with the specified characteristics using the specified MetricRegistry.

Parameters:

registry - MetricRegistry to use for allocating this object

descriptor - GaugeDescriptor that specifies various characteristics of the resulting TimeStampedGauge

TimeStampedGauge

public TimeStampedGauge(MetricRegistry registry,
                GaugeDescriptor descriptor,
                String uid)

Constructs a TimeStampedGauge with the specified UID and other characteristics using the specified MetricRegistry.

Parameters:

registry - MetricRegistry to use for allocating this object

descriptor - GaugeDescriptor that specifies various characteristics of the resulting TimeStampedGauge

uid - UID to assign to the resulting TimeStampedGauge

Throws:

IllegalArgumentException - if a null value is supplied for either the GaugeDescriptor or MetricRegistry argument

Method Detail

extractDataPoint

public GaugeDataPoint extractDataPoint()

Extract a GaugeDataPoint from this object.

Specified by:

extractDataPoint in interface TimeStampedMetric

Returns:

the current value of this object represented as a GaugeDataPoint

getDescriptor

public GaugeDescriptor getDescriptor()

Description copied from interface: TimeStampedMetric

Gets the MetricDescriptor that describes this TimeStampedMetric object.

Specified by:

getDescriptor in interface TimeStampedMetric

Returns:

MetricDescriptor that describes this TimeStampedMetric

getMsSpanned

public long getMsSpanned()

Description copied from interface: TimeStampedMetric

Determines the number of milliseconds spanned between the latest (update) time stamp and the oldest (previous) time stamp, accounting for roll-over of the time stamp.

Specified by:

getMsSpanned in interface TimeStampedMetric

Returns:

milliseconds spanned between the update and previous time stamps

getPreviousTimeStamp

public long getPreviousTimeStamp()

Description copied from interface: TimeStampedMetric

Gets the previous time stamp.

Specified by:

getPreviousTimeStamp in interface TimeStampedMetric

Returns:

previous time stamp

getTimeStampManager

protected TimeStampManager getTimeStampManager()

Gets the TimeStampManager that this object uses to manage its associated time stamps.

Returns:

the TimeStampManager for this object

getUid

public String getUid()

Description copied from interface: TimeStampedMetric

Gets the UID.

Specified by:

getUid in interface TimeStampedMetric

Returns:

the UID

getUpdateTimeStamp

public long getUpdateTimeStamp()

Description copied from interface: TimeStampedMetric

Gets the update time stamp.

Specified by:

getUpdateTimeStamp in interface TimeStampedMetric

Returns:

update time stamp

getValue

public Long getValue()

Specified by:

getValue in interface com.codahale.metrics.Gauge<Long>

reset

public void reset()

Prepares the gauge for use in a new time period by saving the most recent update time stamp as the previous time stamp. The value is not changed.

Specified by:

reset in interface TimeStampedMetric

setDescriptor

public void setDescriptor(GaugeDescriptor toSet)

Sets the GaugeDescriptor that specifies characteristics of this TimeStampedGauge.

Parameters:

toSet - the GaugeDescriptor for this object

setPreviousTimeStamp

public void setPreviousTimeStamp(long time)

Description copied from interface: TimeStampedMetric

Sets the previous time stamp.

Specified by:

setPreviousTimeStamp in interface TimeStampedMetric

Parameters:

time - previous time stamp

setUid

public void setUid(String toSet)

Description copied from interface: TimeStampedMetric

Sets the UID of this object.

Specified by:

setUid in interface TimeStampedMetric

Parameters:

toSet - new UID for this object

setUpdateTimeStamp

public void setUpdateTimeStamp(long time)

Description copied from interface: TimeStampedMetric

Sets the update time stamp.

Specified by:

setUpdateTimeStamp in interface TimeStampedMetric

Parameters:

time - update time stamp

setValue

public void setValue(long toSet)

Sets the value of this TimeStampedGauge.

Parameters:

toSet - the value for this object

toDebugString

public String toDebugString()

Gets a detailed representation of this object to facilitate debugging.

Returns:

debug representation of object

toString

public String toString()

Overrides:

toString in class Object

updateTimeStamp

public void updateTimeStamp()

Description copied from interface: TimeStampedMetric

Convenience method that sets the update time stamp to the current time.

Specified by:

updateTimeStamp in interface TimeStampedMetric