Top Description Fields Constructors Methods
org.springframework.jmx.export.metadata

public Class ManagedMetric

extends AbstractJmxAttribute
Class Inheritance
Imports
org.springframework.jmx.support.MetricType, org.springframework.lang.Nullable, org.springframework.util.Assert
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.
Author
Jennifer Hickey
Since
3.0
See Also
org.springframework.jmx.export.assembler.MetadataMBeanInfoAssembler

Field Summary

Modifier and TypeField and Description
private String
category

private String
displayName

private MetricType
metricType

private int
persistPeriod

private String
persistPolicy

private String
unit

Constructor Summary

AccessConstructor and Description
public
ManagedMetric()

Method Summary

Modifier and TypeMethod and Description
public String
getCategory()

The category of this metric (ex.

public String
getDisplayName()

A display name for this metric.

public MetricType
getMetricType()

A description of how this metric's values change over time.

public int
getPersistPeriod()

The persist period for this metric.

public String
getPersistPolicy()

The persist policy for this metric.

public String
getUnit()

The expected unit of measurement values.

public void
setCategory(String category)

The category of this metric (ex.

public void
setDisplayName(String displayName)

A display name for this metric.

public void
setMetricType(MetricType metricType)

A description of how this metric's values change over time.

public void
setPersistPeriod(int persistPeriod)

The persist period for this metric.

public void
setPersistPolicy(String persistPolicy)

The persist policy for this metric.

public void
setUnit(String unit)

The expected unit of measurement values.

Inherited from org.springframework.jmx.export.metadata.AbstractJmxAttribute:
getCurrencyTimeLimitgetDescriptionsetCurrencyTimeLimitsetDescription

Field Detail

categoryback to summary
private String category
Annotations
@Nullable
displayNameback to summary
private String displayName
Annotations
@Nullable
metricTypeback to summary
private MetricType metricType
persistPeriodback to summary
private int persistPeriod
persistPolicyback to summary
private String persistPolicy
Annotations
@Nullable
unitback to summary
private String unit
Annotations
@Nullable

Constructor Detail

ManagedMetricback to summary
public ManagedMetric()

Method Detail

getCategoryback to summary
public String getCategory()

The category of this metric (ex. throughput, performance, utilization).

Annotations
@Nullable
getDisplayNameback to summary
public String getDisplayName()

A display name for this metric.

Annotations
@Nullable
getMetricTypeback to summary
public MetricType getMetricType()

A description of how this metric's values change over time.

getPersistPeriodback to summary
public int getPersistPeriod()

The persist period for this metric.

getPersistPolicyback to summary
public String getPersistPolicy()

The persist policy for this metric.

Annotations
@Nullable
getUnitback to summary
public String getUnit()

The expected unit of measurement values.

Annotations
@Nullable
setCategoryback to summary
public void setCategory(String category)

The category of this metric (ex. throughput, performance, utilization).

setDisplayNameback to summary
public void setDisplayName(String displayName)

A display name for this metric.

setMetricTypeback to summary
public void setMetricType(MetricType metricType)

A description of how this metric's values change over time.

setPersistPeriodback to summary
public void setPersistPeriod(int persistPeriod)

The persist period for this metric.

setPersistPolicyback to summary
public void setPersistPolicy(String persistPolicy)

The persist policy for this metric.

setUnitback to summary
public void setUnit(String unit)

The expected unit of measurement values.