io.pcp.parfait.MonitoredNumeric 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 javax.measure.Unit;

/**
 * Base implementation of {@link Monitorable} which deals with numeric values.
 * Provides convenience methods to increment and decrement the current value by
 * one unit.
 */
abstract class MonitoredNumeric extends MonitoredValue {
    public MonitoredNumeric(String name, String description, MonitorableRegistry registry,
            T initialValue, Unit unit) {
        super(name, description, registry, initialValue, unit);
    }

    /**
     * Increments the current value by 1.
     */
    public abstract void inc();

    /**
     * Increments the current value by the specified amount.
     */
    public abstract void inc(int delta);

    /**
     * Decrements the current value by 1.
     */
    public abstract void dec();

    /**
     * Decrements the current value by the specified amount.
     */
    public abstract void dec(int delta);
}