com.tibco.tea.agent.metrics

Class MetricIdentifier

java.lang.Object

com.tibco.tea.agent.metrics.MetricIdentifier

public class MetricIdentifier
extends Object

Identifier class for Metric.

{equals(Object) and {hashCode() do not depend on metricDescription and metricUnit. Hence two MetricIdentier objects will be considered equal as long as metricName, objectKey and objectType are same.

Constructor Summary

Constructors

Constructor and Description
MetricIdentifier(String objectType, String objectKey, String metricName, String metricDescription, String metricUnit) Constructs a MetricIdentifier

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDescription() Return the description of the metric
String	getMetricName() Returns the name of the metric
String	getMetricUnit() Returns the unit specifying what the metric is measuring.
String	getObjectKey() Returns the key for identifying the object instance to which the metric belongs
String	getObjectType() Returns the name of the TeaObjectType for the object instance to which the metric belongs
int	hashCode()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetricIdentifier

public MetricIdentifier(String objectType,
                String objectKey,
                String metricName,
                String metricDescription,
                String metricUnit)

Constructs a MetricIdentifier

Parameters:

objectType - name of the TeaObjectType for the object instance

objectKey - key for identifying the object instance

metricName - name of the metric

metricDescription - description of the metric

metricUnit - Unit specifying what the metric is measuring. e.g. when measuring JVM memory, unit could be kilobytes.

Method Detail

getMetricName

public String getMetricName()

Returns the name of the metric

Returns:

the metricName

getObjectKey

public String getObjectKey()

Returns the key for identifying the object instance to which the metric belongs

Returns:

the objectKey

getObjectType

public String getObjectType()

Returns the name of the TeaObjectType for the object instance to which the metric belongs

Returns:

the objectType

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDescription

public String getDescription()

Return the description of the metric

Returns:

the metricDescription

getMetricUnit

public String getMetricUnit()

Returns the unit specifying what the metric is measuring. e.g. when measuring JVM memory, unit could be kilobytes.

Returns:

the metricUnit