io.pcp.parfait

Class TimeWindowCounterBuilder

java.lang.Object

io.pcp.parfait.TimeWindowCounterBuilder

public class TimeWindowCounterBuilder
extends Object

Factory class to produce multiple sets of TimeWindowCounters with a specific and consistent set of TimeWindows, and in turn produce PollingMonitoredValues which watch those TimeWindowCounters. Can either create the TimeWindowCounters from scratch, or 'copy' an existing MonitoredCounter.

Constructor Summary

Constructors

Constructor and Description
TimeWindowCounterBuilder(MonitorableRegistry registry, TimeWindow... windows)

Method Summary

Modifier and Type	Method and Description
CompositeCounter	build(String baseName, String baseDescription, javax.measure.Unit<?> unit) Builds a new CompositeCounter, comprised of TimeWindowCounters, and registers PollingMonitoredValues to detect changes in their values.
CompositeCounter	copyFrom(MonitoredCounter templateCounter) Creates a new CompositeCounter wrapping TimeWindowCounters (and creating PollingMonitoredValues), using the supplied counter's name, description, and unit as the template.
CompositeCounter	wrapCounter(MonitoredCounter templateCounter) Creates a new CompositeCounter wrapping TimeWindowCounters (and creating PollingMonitoredValues), using the supplied MonitoredCounter's name, description, and unit as the template.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeWindowCounterBuilder

public TimeWindowCounterBuilder(MonitorableRegistry registry,
                                TimeWindow... windows)

Method Detail

build

public CompositeCounter build(String baseName,
                              String baseDescription,
                              javax.measure.Unit<?> unit)

Builds a new CompositeCounter, comprised of TimeWindowCounters, and registers PollingMonitoredValues to detect changes in their values.

Parameters:

baseName - the base name of the new MonitoredValues, which will have the window name, e.g. ".60s", appended to it for each window

baseDescription - the base description of the new MonitoredValues, to be appended with e.g. " [60s]"

unit - the Unit to use for the new values

Returns:

a CompositeCounter wrapping a set of new TimeWindow-based counters

copyFrom

public CompositeCounter copyFrom(MonitoredCounter templateCounter)

Creates a new CompositeCounter wrapping TimeWindowCounters (and creating PollingMonitoredValues), using the supplied counter's name, description, and unit as the template.

Parameters:

templateCounter - a MonitoredCounter whose name, description, and unit should be copied

Returns:

a CompositeCounter wrapping a set of new TimeWindow-based counters

wrapCounter

public CompositeCounter wrapCounter(MonitoredCounter templateCounter)

Creates a new CompositeCounter wrapping TimeWindowCounters (and creating PollingMonitoredValues), using the supplied MonitoredCounter's name, description, and unit as the template. Also wraps the supplied MonitoredCounter itself (hence providing a single incrementable Counter which will increment both an overall total and a set of TimeWindow counters)

Parameters:

templateCounter - a Counter whose name, description, and unit should be copied

Returns:

a CompositeCounter wrapping a set of new TimeWindow-based counters and the supplied templateCounter