net.sf.ehcache.util.counter.Counter Maven / Gradle / Ivy

Go to download

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;

/**
 * A simple counter
 * 
 * @author Abhishek Sanoujam
 * 
 * @since 1.7
 */
public interface Counter {

    /**
     * Increment the counter by 1
     * 
     * @return the value after incrementing
     */
    long increment();

    /**
     * Decrement the counter by 1
     * 
     * @return the value after decrementing
     */
    long decrement();

    /**
     * Returns the value of the counter and sets it to the new value
     * 
     * @param newValue
     * @return Returns the old value
     */
    long getAndSet(long newValue);

    /**
     * Gets current value of the counter
     * 
     * @return current value of the counter
     */
    long getValue();

    /**
     * Increment the counter by given amount
     * 
     * @param amount
     * @return the value of the counter after incrementing
     */
    long increment(long amount);

    /**
     * Decrement the counter by given amount
     * 
     * @param amount
     * @return the value of the counter after decrementing
     */
    long decrement(long amount);

    /**
     * Sets the value of the counter to the supplied value
     * 
     * @param newValue
     */
    void setValue(long newValue);

}