net.sf.ehcache.util.counter.CounterConfig 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;

/**
 * Config for a simple Counter
 * 
 * @author Abhishek Sanoujam
 * @since 1.7
 * 
 */
public class CounterConfig {

    private final long initialValue;

    /**
     * Creates a config with the initial value
     * 
     * @param initialValue
     */
    public CounterConfig(long initialValue) {
        this.initialValue = initialValue;
    }

    /**
     * Gets the initial value
     * 
     * @return the initial value of counters created by this config
     */
    public final long getInitialValue() {
        return initialValue;
    }

    /**
     * Creates and returns a Counter based on the initial value
     * 
     * @return The counter created by this config
     */
    public Counter createCounter() {
        return new CounterImpl(initialValue);
    }
}