Clover coverage report -
Coverage timestamp: Thu Jul 5 2007 20:02:32 EDT
file stats: LOC: 109   Methods: 0
NCLOC: 16   Classes: 1
 
 Source file Conditionals Statements Methods TOTAL
CacheMgmtInterceptorMBean.java - - - -
coverage
 1    /*
 2    * JBoss, Home of Professional Open Source
 3    * Copyright 2005, JBoss Inc., and individual contributors as indicated
 4    * by the @authors tag. See the copyright.txt in the distribution for a
 5    * full listing of individual contributors.
 6    *
 7    * This is free software; you can redistribute it and/or modify it
 8    * under the terms of the GNU Lesser General Public License as
 9    * published by the Free Software Foundation; either version 2.1 of
 10    * the License, or (at your option) any later version.
 11    *
 12    * This software is distributed in the hope that it will be useful,
 13    * but WITHOUT ANY WARRANTY; without even the implied warranty of
 14    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 15    * Lesser General Public License for more details.
 16    *
 17    * You should have received a copy of the GNU Lesser General Public
 18    * License along with this software; if not, write to the Free
 19    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 20    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 21    */
 22    package org.jboss.cache.interceptors;
 23   
 24    /**
 25    * Interface capturing basic cache management statistics
 26    *
 27    * @author Jerry Gauthier
 28    * @version $Id: CacheMgmtInterceptorMBean.java,v 1.7 2007/05/23 10:28:50 msurtani Exp $
 29    */
 30    public interface CacheMgmtInterceptorMBean extends InterceptorMBean
 31    {
 32    /**
 33    * Returns the number of cache attribute hits
 34    *
 35    * @return the number of cache hits
 36    */
 37    long getHits();
 38   
 39    /**
 40    * Returns the number of cache attribute misses
 41    *
 42    * @return the number of cache misses
 43    */
 44    long getMisses();
 45   
 46    /**
 47    * Returns the number of cache attribute put operations
 48    *
 49    * @return the number of cache put operations
 50    */
 51    long getStores();
 52   
 53    /**
 54    * Returns the number of cache eviction operations
 55    *
 56    * @return the number of cache eviction operations
 57    */
 58    long getEvictions();
 59   
 60    int getNumberOfAttributes();
 61   
 62    int getNumberOfNodes();
 63   
 64    /**
 65    * Returns the hit/miss ratio for the cache
 66    * This ratio is defined as hits/(hits + misses)
 67    *
 68    * @return the hit/miss ratio for the cache
 69    */
 70    double getHitMissRatio();
 71   
 72    /**
 73    * Returns the read/write ratio for the cache
 74    * This ratio is defined as (hits + misses)/stores
 75    *
 76    * @return the read/writes ratio for the cache
 77    */
 78    double getReadWriteRatio();
 79   
 80    /**
 81    * Returns average milliseconds for an attribute read operation
 82    * This includes both hits and misses.
 83    *
 84    * @return the average number of milliseconds for a read operation
 85    */
 86    long getAverageReadTime();
 87   
 88    /**
 89    * Returns average milliseconds for an attribute write operation
 90    *
 91    * @return the average number of milliseconds for a write operation
 92    */
 93    long getAverageWriteTime();
 94   
 95    /**
 96    * Returns seconds since cache started
 97    *
 98    * @return the number of seconds since the cache was started
 99    */
 100    long getElapsedTime();
 101   
 102    /**
 103    * Returns seconds since cache statistics reset
 104    * If statistics haven't been reset, this will be the same as ElapsedTime
 105    *
 106    * @return the number of seconds since the cache statistics were last reset
 107    */
 108    long getTimeSinceReset();
 109    }