net.sf.ehcache.statistics.CoreStatistics Maven / Gradle / Ivy

Go to download

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

Ehcache is an open source, standards-based cache used to boost performance, offload the database and simplify scalability. Ehcache is robust, proven and full-featured and this has made it the most widely-used Java-based cache.

There is a newer version: 2.10.9.2

Show newest version

/**
 *  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.statistics;

import net.sf.ehcache.CacheOperationOutcomes;
import net.sf.ehcache.statistics.CoreStatistics.CountOperation;
import net.sf.ehcache.store.StoreOperationOutcomes;
import net.sf.ehcache.transaction.xa.XaCommitOutcome;
import net.sf.ehcache.transaction.xa.XaRecoveryOutcome;
import net.sf.ehcache.transaction.xa.XaRollbackOutcome;

/**
 * The CoreStatistics interface.
 *
 * @author cschanck
 */
public interface CoreStatistics {

    /**
     * The Interface CountOperation.
     *
     * @param  the generic type
     */
    public interface CountOperation {

        /**
         * Value.
         *
         * @param result the result
         * @return the long
         */
        long value(T result);

        /**
         * Value.
         *
         * @param results the results
         * @return the long
         */
        long value(T... results);
    }

    /**
     * Gets the.
     *
     * @return the count operation
     */
    public CountOperation get();

    /**
     * Put.
     *
     * @return the count operation
     */
    public CountOperation put();

    /**
     * Removes the.
     *
     * @return the count operation
     */
    public CountOperation remove();

    /**
     * Local heap get.
     *
     * @return the count operation
     */
    public CountOperation localHeapGet();

    /**
     * Local heap put.
     *
     * @return the count operation
     */
    public CountOperation localHeapPut();

    /**
     * Local heap remove.
     *
     * @return the count operation
     */
    public CountOperation localHeapRemove();

    /**
     * Local off heap get.
     *
     * @return the count operation
     */
    public CountOperation localOffHeapGet();

    /**
     * Local off heap put.
     *
     * @return the count operation
     */
    public CountOperation localOffHeapPut();

    /**
     * Local off heap remove.
     *
     * @return the count operation
     */
    public CountOperation localOffHeapRemove();

    /**
     * Local disk get.
     *
     * @return the count operation
     */
    public CountOperation localDiskGet();

    /**
     * Local disk put.
     *
     * @return the count operation
     */
    public CountOperation localDiskPut();

    /**
     * Local disk remove.
     *
     * @return the count operation
     */
    public CountOperation localDiskRemove();

    /**
     * Xa commit.
     *
     * @return the count operation
     */
    public CountOperation xaCommit();

    /**
     * Xa recovery.
     *
     * @return the count operation
     */
    public CountOperation xaRecovery();

    /**
     * Xa rollback.
     *
     * @return the count operation
     */
    public CountOperation xaRollback();

    /**
     * Cache eviction.
     *
     * @return the count operation
     */
    public CountOperation cacheEviction();

    /**
     * Cache expiration.
     *
     * @return the count operation
     */
    public CountOperation cacheExpiration();

    /**
     * Cache cluster event.
     * 
     * @return the count operation
     */
    public CountOperation cacheClusterEvent();

}