com.h3c.sdn.metric

Class TimeStampedMetricDescriptor

java.lang.Object

com.h3c.sdn.metric.TimeStampedMetricDescriptor

public class TimeStampedMetricDescriptor
extends Object

Container object that pairs a MetricDescriptor with a time stamp.

Constructor Summary

Constructors

Constructor and Description
TimeStampedMetricDescriptor(MetricDescriptor descriptor) Creates a new TimeStampedMetricDescriptor using the current time.
TimeStampedMetricDescriptor(MetricDescriptor descriptor, long timeStamp) Creates a new TimeStampedMetricDescriptor using the specified time stamp.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object toCompare)
MetricDescriptor	getDescriptor() Gets the MetricDescriptor.
long	getTimeStamp() Gets the time stamp.
int	hashCode()
void	setTimeStamp(long toSet) Sets the time stamp.
String	toDebugString() Gets a detailed representation of this object to facilitate debugging.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TimeStampedMetricDescriptor

public TimeStampedMetricDescriptor(MetricDescriptor descriptor)

Creates a new TimeStampedMetricDescriptor using the current time.

Parameters:

descriptor - the MetricDescriptor to associate with a time stamp

Throws:

IllegalArgumentException - if a null MetricDescriptor is supplied

TimeStampedMetricDescriptor

public TimeStampedMetricDescriptor(MetricDescriptor descriptor,
                           long timeStamp)

Creates a new TimeStampedMetricDescriptor using the specified time stamp.

Parameters:

descriptor - the MetricDescriptor to associate with a time stamp

timeStamp - the initial time stamp (in UTC) to associate with the provided MetricDescriptor

Throws:

IllegalArgumentException - if a null MetricDescriptor is supplied

Method Detail

equals

public boolean equals(Object toCompare)

Overrides:

equals in class Object

getDescriptor

public MetricDescriptor getDescriptor()

Gets the MetricDescriptor.

Returns:

descriptor

getTimeStamp

public long getTimeStamp()

Gets the time stamp.

Returns:

time stamp

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setTimeStamp

public void setTimeStamp(long toSet)

Sets the time stamp.

Parameters:

toSet - time stamp

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