io.pcp.parfait

Class AbstractMonitorable<T>

java.lang.Object

io.pcp.parfait.AbstractMonitorable<T>

All Implemented Interfaces:

Monitorable<T>

Direct Known Subclasses:

MonitoredConstant, MonitoredCounter, MonitoredValue, PollingMonitoredValue

public abstract class AbstractMonitorable<T>
extends Object
implements Monitorable<T>

Convenience base class for implementing Monitorable. Provides implementations for metadata methods and a high performance synchronization-free implementation of Monitor notification.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	LOG

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMonitorable(String name, String description, Class<T> type, javax.measure.Unit<?> unit, ValueSemantics semantics)

Method Summary

Modifier and Type	Method and Description
void	attachMonitor(Monitor monitor) Attaches the provided Monitor.
String	getDescription()
String	getName()
ValueSemantics	getSemantics()
Class<T>	getType()
javax.measure.Unit<?>	getUnit()
protected void	logValue()
protected void	notifyMonitors()
protected void	registerSelf(MonitorableRegistry registry)
void	removeMonitor(Monitor monitor) Removed the provided Monitor from the list of attached Monitors.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.pcp.parfait.Monitorable

get

Field Detail

LOG

protected final org.slf4j.Logger LOG

Constructor Detail

AbstractMonitorable

protected AbstractMonitorable(String name,
                              String description,
                              Class<T> type,
                              javax.measure.Unit<?> unit,
                              ValueSemantics semantics)

Method Detail

registerSelf

protected void registerSelf(MonitorableRegistry registry)

getName

public String getName()

Specified by:

getName in interface Monitorable<T>

Returns:

the name of this Monitorable. Name must be unique across a single JVM. Typically uses a logging-framework-style dotted string ("java.vm.gc.count") but may be any arbitrary String value.

getDescription

public String getDescription()

Specified by:

getDescription in interface Monitorable<T>

Returns:

a human-readable descriptive text for the Monitorable. May be used by tools to assist understanding of the metric.

getType

public Class<T> getType()

Specified by:

getType in interface Monitorable<T>

Returns:

the type of the value returned by the Monitorable.get() method.

getUnit

public javax.measure.Unit<?> getUnit()

Specified by:

getUnit in interface Monitorable<T>

Returns:

the JSR-363 Unit represented by the value of this Monitorable. This may be used to do comparisons and rate-conversions between metrics which do not share the same scale. Values which do not take a unit should use AbstractUnit.ONE; values for which no unit is sensible (e.g. String values) may return null.

getSemantics

public ValueSemantics getSemantics()

Specified by:

getSemantics in interface Monitorable<T>

Returns:

the semantics of this Monitorable. Some tools may treat constant, variable, or monotonically-increasing values differently; this enables them to do so if required.

attachMonitor

public void attachMonitor(Monitor monitor)

Description copied from interface: Monitorable

Attaches the provided Monitor. Once attached the Monitor will be notified whenever the value of this Monitorable changes.

Specified by:

attachMonitor in interface Monitorable<T>

Parameters:

monitor - the Monitor to attach.

removeMonitor

public void removeMonitor(Monitor monitor)

Description copied from interface: Monitorable

Removed the provided Monitor from the list of attached Monitors.

Specified by:

removeMonitor in interface Monitorable<T>

Parameters:

monitor - the Monitor to remove.

notifyMonitors

protected final void notifyMonitors()

logValue

protected final void logValue()