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

/**
 *  Copyright 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;

/**
 * An implementation of {@link SampledRateCounter}
 * 
 * @author Abhishek Sanoujam
 * @since 1.7
 * 
 */
public class SampledRateCounterImpl extends SampledCounterImpl implements SampledRateCounter {

    private static final String OPERATION_NOT_SUPPORTED_MSG = "This operation is not supported. Use SampledCounter Or Counter instead";

    private long numeratorValue;
    private long denominatorValue;

    /**
     * Constructor accepting the config
     * 
     * @param config
     */
    public SampledRateCounterImpl(SampledRateCounterConfig config) {
        super(config);
    }

    /**
     * {@inheritDoc}
     */
    public synchronized void setValue(long numerator, long denominator) {
        this.numeratorValue = numerator;
        this.denominatorValue = denominator;
    }

    /**
     * {@inheritDoc}
     */
    public synchronized void increment(long numerator, long denominator) {
        this.numeratorValue += numerator;
        this.denominatorValue += denominator;
    }

    /**
     * {@inheritDoc}
     */
    public synchronized void decrement(long numerator, long denominator) {
        this.numeratorValue -= numerator;
        this.denominatorValue -= denominator;
    }

    /**
     * {@inheritDoc}
     */
    public synchronized void setDenominatorValue(long newValue) {
        this.denominatorValue = newValue;
    }

    /**
     * {@inheritDoc}
     */
    public synchronized void setNumeratorValue(long newValue) {
        this.numeratorValue = newValue;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public synchronized long getValue() {
        return denominatorValue == 0 ? 0 : (numeratorValue / denominatorValue);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public synchronized long getAndReset() {
        long prevVal = getValue();
        setValue(0, 0);
        return prevVal;
    }

    // ====== unsupported operations. These operations need multiple params for
    // this class
    /**
     * throws {@link UnsupportedOperationException}
     */
    @Override
    public long getAndSet(long newValue) {
        throw new UnsupportedOperationException(OPERATION_NOT_SUPPORTED_MSG);
    }

    /**
     * throws {@link UnsupportedOperationException}
     */
    @Override
    public synchronized void setValue(long newValue) {
        throw new UnsupportedOperationException(OPERATION_NOT_SUPPORTED_MSG);
    }

    /**
     * throws {@link UnsupportedOperationException}
     */
    @Override
    public long decrement() {
        throw new UnsupportedOperationException(OPERATION_NOT_SUPPORTED_MSG);
    }

    /**
     * throws {@link UnsupportedOperationException}
     */
    @Override
    public long decrement(long amount) {
        throw new UnsupportedOperationException(OPERATION_NOT_SUPPORTED_MSG);
    }

    /**
     * throws {@link UnsupportedOperationException}
     */
    public long getMaxValue() {
        throw new UnsupportedOperationException(OPERATION_NOT_SUPPORTED_MSG);
    }

    /**
     * throws {@link UnsupportedOperationException}
     */
    public long getMinValue() {
        throw new UnsupportedOperationException(OPERATION_NOT_SUPPORTED_MSG);
    }

    /**
     * throws {@link UnsupportedOperationException}
     */
    @Override
    public long increment() {
        throw new UnsupportedOperationException(OPERATION_NOT_SUPPORTED_MSG);
    }

    /**
     * throws {@link UnsupportedOperationException}
     */
    @Override
    public long increment(long amount) {
        throw new UnsupportedOperationException(OPERATION_NOT_SUPPORTED_MSG);
    }

}