com.j256.simplemetrics.metric

Class BaseControlledMetric<V,MV extends MetricValue<V,MV>>

java.lang.Object

com.j256.simplemetrics.metric.BaseControlledMetric<V,MV>

Type Parameters:

V - Value type that we use to adjust this metric-value.

MV - Metric value which wraps and manages the raw value.

All Implemented Interfaces:

com.j256.simplejmx.common.JmxSelfNaming, ControlledMetric<V,MV>, Comparable<BaseControlledMetric<V,MV>>

Direct Known Subclasses:

ControlledMetricAccum, ControlledMetricRatio, ControlledMetricValue

public abstract class BaseControlledMetric<V,MV extends MetricValue<V,MV>>
extends Object
implements ControlledMetric<V,MV>, com.j256.simplejmx.common.JmxSelfNaming, Comparable<BaseControlledMetric<V,MV>>

Base metric class which defines some common fields and methods.

Author:

graywatson

Nested Class Summary

Nested classes/interfaces inherited from interface com.j256.simplemetrics.metric.ControlledMetric

ControlledMetric.AggregationType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseControlledMetric(String component, String module, String name, String description, String unit)

Method Summary

Modifier and Type	Method and Description
void	adjustValue(long value) Adjust the value by a long primitive value.
void	adjustValue(Number value) Adjust the metric with this value.
int	compareTo(BaseControlledMetric<V,MV> metric)
boolean	equals(Object obj)
String	getAggregationTypeName() Return the aggregation type of the metric.
String	getComponent() Component name of the metric.
String	getDescription() Description of the component which is not persisted.
String	getJmxBeanName()
String	getJmxDomainName()
com.j256.simplejmx.common.JmxFolderName[]	getJmxFolderNames()
protected MV	getMetricValue(boolean persisting)
String	getModule() Module name of the metric or null if none.
String	getName() Component name of the metric.
String	getUnit() Unit of the metric such as percentage, megabytes, or per-second.
Number	getValue() Return the number of the metric.
MetricValueDetails	getValueDetails() Return the value details of the metric.
MetricValueDetails	getValueDetailsToPersist() Get the current value details for persisting purposes.
Number	getValueToPersist() Get the current number for persisting purposes.
int	hashCode()
protected MV	storeValue(V value) Stores the value into the metric.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.j256.simplemetrics.metric.ControlledMetric

createInitialValue, getAggregationType, makeValueFromLong, makeValueFromNumber

Constructor Detail

BaseControlledMetric

protected BaseControlledMetric(String component,
                               String module,
                               String name,
                               String description,
                               String unit)

Method Detail

storeValue

protected MV storeValue(V value)

Stores the value into the metric.

getValue

public Number getValue()

Return the number of the metric. This is a transient value good for JMX or other direct monitoring of the metric. Use getValueToPersist() if you want to save the value to disk.

Specified by:

getValue in interface ControlledMetric<V,MV extends MetricValue<V,MV>>

getValueDetails

public MetricValueDetails getValueDetails()

Return the value details of the metric. This is a transient value good for JMX or other direct monitoring of the metric. Use getValueDetailsToPersist() if you want to save the value to disk.

Specified by:

getValueDetails in interface ControlledMetric<V,MV extends MetricValue<V,MV>>

getValueToPersist

public Number getValueToPersist()

Get the current number for persisting purposes. This causes the metrics to be set to reset on next adjustment.

Specified by:

getValueToPersist in interface ControlledMetric<V,MV extends MetricValue<V,MV>>

getValueDetailsToPersist

public MetricValueDetails getValueDetailsToPersist()

Get the current value details for persisting purposes. This causes the metrics to be set to reset on next adjustment.

Specified by:

getValueDetailsToPersist in interface ControlledMetric<V,MV extends MetricValue<V,MV>>

getAggregationTypeName

public String getAggregationTypeName()

Description copied from interface: ControlledMetric

Return the aggregation type of the metric.

Specified by:

getAggregationTypeName in interface ControlledMetric<V,MV extends MetricValue<V,MV>>

adjustValue

public void adjustValue(long value)

Description copied from interface: ControlledMetric

Adjust the value by a long primitive value. If this is an accumulator then it will be added. If this is a value then it will bet set.

Specified by:

adjustValue in interface ControlledMetric<V,MV extends MetricValue<V,MV>>

adjustValue

public void adjustValue(Number value)

Description copied from interface: ControlledMetric

Adjust the metric with this value. If this is an accumulator then it will be added. If this is a value then it will bet set.

Specified by:

adjustValue in interface ControlledMetric<V,MV extends MetricValue<V,MV>>

getJmxDomainName

public String getJmxDomainName()

Specified by:

getJmxDomainName in interface com.j256.simplejmx.common.JmxSelfNaming

getJmxBeanName

public String getJmxBeanName()

Specified by:

getJmxBeanName in interface com.j256.simplejmx.common.JmxSelfNaming

getJmxFolderNames

public com.j256.simplejmx.common.JmxFolderName[] getJmxFolderNames()

Specified by:

getJmxFolderNames in interface com.j256.simplejmx.common.JmxSelfNaming

getComponent

public String getComponent()

Description copied from interface: ControlledMetric

Component name of the metric. This can be something like "heap".

Specified by:

getComponent in interface ControlledMetric<V,MV extends MetricValue<V,MV>>

getModule

public String getModule()

Description copied from interface: ControlledMetric

Module name of the metric or null if none. This can be something like "oldGen".

Specified by:

getModule in interface ControlledMetric<V,MV extends MetricValue<V,MV>>

getName

public String getName()

Description copied from interface: ControlledMetric

Component name of the metric. This can be something like "usedPercentage".

Specified by:

getName in interface ControlledMetric<V,MV extends MetricValue<V,MV>>

getDescription

public String getDescription()

Description copied from interface: ControlledMetric

Description of the component which is not persisted. Here for code documentation purposes and JMX.

Specified by:

getDescription in interface ControlledMetric<V,MV extends MetricValue<V,MV>>

getUnit

public String getUnit()

Description copied from interface: ControlledMetric

Unit of the metric such as percentage, megabytes, or per-second.

Specified by:

getUnit in interface ControlledMetric<V,MV extends MetricValue<V,MV>>

compareTo

public int compareTo(BaseControlledMetric<V,MV> metric)

Specified by:

compareTo in interface Comparable<BaseControlledMetric<V,MV extends MetricValue<V,MV>>>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getMetricValue

protected MV getMetricValue(boolean persisting)