org.springframework.jmx.export.metadata
Class ManagedMetric

java.lang.Object
  extended by org.springframework.jmx.export.metadata.AbstractJmxAttribute
      extended by org.springframework.jmx.export.metadata.ManagedMetric

public class ManagedMetric
extends AbstractJmxAttribute

Metadata that indicates to expose a given bean property as a JMX attribute, with additional descriptor properties that indicate that the attribute is a metric. Only valid when used on a JavaBean getter.

Since:
3.0
Author:
Jennifer Hickey
See Also:
MetadataMBeanInfoAssembler

Constructor Summary
ManagedMetric()
           
 
Method Summary
 String getCategory()
           
 String getDisplayName()
           
 MetricType getMetricType()
           
 int getPersistPeriod()
           
 String getPersistPolicy()
           
 String getUnit()
           
 void setCategory(String category)
           
 void setDisplayName(String displayName)
           
 void setMetricType(MetricType metricType)
           
 void setPersistPeriod(int persistPeriod)
           
 void setPersistPolicy(String persistPolicy)
           
 void setUnit(String unit)
           
 
Methods inherited from class org.springframework.jmx.export.metadata.AbstractJmxAttribute
getCurrencyTimeLimit, getDescription, setCurrencyTimeLimit, setDescription
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ManagedMetric

public ManagedMetric()
Method Detail

getCategory

public String getCategory()
Returns:
The category of this metric (ex. throughput, performance, utilization)

getDisplayName

public String getDisplayName()
Returns:
A display name for this metric

getMetricType

public MetricType getMetricType()
Returns:
A description of how this metric's values change over time

getPersistPeriod

public int getPersistPeriod()
Returns:
The persist period for this metric

getPersistPolicy

public String getPersistPolicy()
Returns:
The persist policy for this metric

getUnit

public String getUnit()
Returns:
The expected unit of measurement values

setCategory

public void setCategory(String category)
Parameters:
category - The category of this metric (ex. throughput, performance, utilization)

setDisplayName

public void setDisplayName(String displayName)
Parameters:
displayName - A display name for this metric

setMetricType

public void setMetricType(MetricType metricType)
Parameters:
metricType - A description of how this metric's values change over time

setPersistPeriod

public void setPersistPeriod(int persistPeriod)
Parameters:
persistPeriod - The persist period for this metric

setPersistPolicy

public void setPersistPolicy(String persistPolicy)
Parameters:
persistPolicy - The persist policy for this metric

setUnit

public void setUnit(String unit)
Parameters:
unit - The expected unit of measurement values