net.sf.ehcache.util.counter.sampled.SampledRateCounter Maven / Gradle / Ivy

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

This is the ehcache core module. Pair it with other modules for added functionality.

There is a newer version: 2.6.11

/**
 *  Copyright 2003-2010 Terracotta, Inc.
 *
 *  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 net.sf.ehcache.util.counter.sampled;

/**
 * Interface of a sampled rate counter -- a counter that keeps sampled values of
 * rates
 *
 * @author Abhishek Sanoujam
 * @since 1.7
 *
 */
public interface SampledRateCounter extends SampledCounter {

    /**
     * Increments the numerator and denominator by the passed values
     *
     * @param numerator
     * @param denominator
     */
    void increment(long numerator, long denominator);

    /**
     * Decrements the numerator and denominator by the passed values
     *
     * @param numerator
     * @param denominator
     */
    void decrement(long numerator, long denominator);

    /**
     * Sets the values of the numerator and denominator to the passed values
     *
     * @param numerator
     * @param denominator
     */
    void setValue(long numerator, long denominator);

    /**
     * Sets the value of the numerator to the passed value
     *
     * @param newValue
     */
    void setNumeratorValue(long newValue);

    /**
     * Sets the value of the denominator to the passed value
     *
     * @param newValue
     */
    void setDenominatorValue(long newValue);

}