io.pcp.parfait.MonitoredValue Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of parfait-core Show documentation

Java performance monitoring framework, including PCP bridge

The newest version!

/*
 * Copyright 2009-2017 Aconex
 *
 * Licensed under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied.  See the License for the specific language governing
 * permissions and limitations under the License.
 */

package io.pcp.parfait;

import static tech.units.indriya.AbstractUnit.ONE;

import javax.measure.Unit;

/**
 * MonitoredValue provides a convenient implementation of {@link Monitorable}
 * for free-running values that are updatable through a single set method call.
 * 
 * A free-running value is a value that increments and decrements at-will over
 * time. This is essentially a "point in time" measurement. An example of an
 * instantaneous value is the number of active HTTP sessions.
 * 
 * It is recommended that monotonically-increasing counters be implemented using
 * the class {@link MonitoredCounter} in preference to this class.
 */
public class MonitoredValue extends SettableValue {
    public MonitoredValue(String name, String description, T initialValue) {
        this(name, description, MonitorableRegistry.DEFAULT_REGISTRY,
                initialValue);
    }

    public MonitoredValue(String name, String description, T initialValue, Unit unit) {
        this(name, description, MonitorableRegistry.DEFAULT_REGISTRY, initialValue, unit);
    }

    public MonitoredValue(String name, String description, MonitorableRegistry registry,
            T initialValue) {
        this(name, description, registry, initialValue, ONE);
    }

    public MonitoredValue(String name, String description, MonitorableRegistry registry,
            T initialValue, Unit unit) {
        super(name, description, registry, initialValue, unit, ValueSemantics.FREE_RUNNING);
    }
}