com.alachisoft.ncache.common.caching.statistics.customcounters.PerformanceCounter Maven / Gradle / Ivy

Go to download
/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */
package com.alachisoft.ncache.common.caching.statistics.customcounters;

/**
 * @author Muneeb Shahid
 */
public interface PerformanceCounter {

    /**
     * Gets the name of the counter.
     *
     * @return
     */
    public String getName();

    /**
     * Gets the name of the instance to which this counter belongs.
     *
     * @return
     */
    public String getInstanceName();

    /**
     * Gets the category of the counter.
     *
     * @return
     */
    public String getCategory();

    /**
     * Increments the counter value by one.
     */
    public void increment();

    /**
     * Decrements the counter value by given value
     *
     * @param value
     */
    public void incrementBy(double value);

    /**
     * Increments the counter value by one.
     */
    public void decrement();

    /**
     * Decrements the counter value by given value.
     *
     * @param value
     */
    public void decrementBy(double value);

    /**
     * Gets the counter value
     *
     * @return
     */
    public double getValue();

    /**
     * Sets the counter value
     *
     * @param _value
     */
    public void setValue(double _value);

    public void reset();
}