JCache.java

Index Score
net.sf.ehcache.jcache
ehcache

View: Reasons, Metrics, Source Code

These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.

MetricDescription
DOC_COMMENTNumber of javadoc comment lines
COMMENTSComment lines
SIZESize of the file in bytes
DECL_COMMENTSComments in declarations
RETURNSNumber of return points from functions
JAVA0144JAVA0144 Line exceeds maximum M characters
INTERFACE_COMPLEXITYInterface complexity
JAVA0126JAVA0126 Method declares unchecked exception in throws
LINESNumber of lines in the source file
JAVA0115JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception'
JAVA0034JAVA0034 Missing braces in if statement
FUNCTIONSNumber of function declarations
JAVA0160JAVA0160 Method does not throw specified exception
PARAMSNumber of formal parameter declarations
JAVA0108JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
JAVA0117JAVA0117 Missing javadoc: method 'method'
EXITSProcedure exits
PROGRAM_VOLUMEHalstead program volume
JAVA0136JAVA0136 N methods defined in class (maximum: M)
EXEC_COMMENTSComments in executable code
LINE_COMMENTNumber of line comments
JAVA0254JAVA0254 Use enhanced for loop construct instead of Iterator
BLOCKSNumber of blocks
COMPARISONSNumber of comparison operators
JAVA0110JAVA0110 Incorrect javadoc: no @return tag
JAVA0145JAVA0145 Tab character used in source file
/** * Copyright 2003-2008 Luck Consulting Pty Ltd * * 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.jcache; import net.sf.ehcache.Ehcache; import net.sf.ehcache.Element; import net.sf.ehcache.loader.CacheLoader; import net.sf.jsr107cache.CacheEntry; import net.sf.jsr107cache.CacheException; import net.sf.jsr107cache.CacheListener; import net.sf.jsr107cache.CacheStatistics; import java.util.Collection; import java.util.HashSet; import java.util.Iterator; import java.util.List; import java.util.Map; import java.util.Set; import java.util.logging.Logger; import java.util.logging.Level; /** * Warning: This class is related to the JSR107 specification, which is in draft. It is subject to change without notice. * <p/> * A cache implementation that matches the draft JCACHE specification. * <p/> * WARNING: The JCache specfication is in draft and this API will change up until the time that JCACHE is finalised. * <p/> * It is not possible for one class to implement both JCACHE and Ehcache * in the same class due to conflicts with method signatures on get and remove. * <p/> * This implementation is an adaptor to Ehcache, and will exhibit the same underlying characteristics as Ehcache. Additiona features * have been added to Ehcache to match the JCache features. All of these features can be configured in ehcache.xml. * <p/> * The current JCache CacheManager class, available in the draft, is considered unworkable. Instead, use the Ehcache <code>cacheManager.getJCache(String name)</code> * to get a JCache. The JCache CacheManager is unlikely to make it into the final spec. * <p/> * The recommended creational pattern for JCache is one of: * <ol> * <li>Add a cache to ehcache.xml and use <code>cacheManager.getJCache(String name)</code> to access it. * <li>Create a JCache from an Ehcache, using one of the constructors in this class. Two types of CacheLoader can be specified, in which * case the underlying Ehcache loader is replaced by the one specified. * <li>Create an Ehcache from a Cache using its constructor, then a JCache, and then add it to the ehcache CacheManager using <code>cacheManager.addCache(JCache jCache)</code> * </ol> * @author Greg Luck * @version $Id: JCache.java 744 2008-08-16 20:10:49Z gregluck $ * @since 1.3 */ public class JCache implements net.sf.jsr107cache.Cache { private static final Logger LOG = Logger.getLogger(JCache.class.getName()); /** * An Ehcache backing instance */ private Ehcache cache; /** * A constructor for JCache. * <p/> * JCache is an adaptor for an Ehcache, and therefore requires an Ehcache in its constructor. * <p/> * @param cache An ehcache * @since 1.4 * @see "class description for recommended usage" */ public JCache(Ehcache cache) { this.cache = cache; } /** * A constructor for JCache. * <p/> * JCache is an adaptor for an Ehcache, and therefore requires an Ehcache in its constructor. * <p/> * @param cache An ehcache * @param cacheLoader used to load entries when they are not in the cache. If this is null, it is * set for the cache. If null, the JCache will inherit the CacheLoader set for the backing ehcache. * If specified, the underlying ehcache will have it's loader replaced. * @since 1.3 * @see "class description for recommended usage" */ public JCache(Ehcache cache, net.sf.jsr107cache.CacheLoader cacheLoader) { this.cache = cache; if (cacheLoader != null) { cache.setCacheLoader((CacheLoader) cacheLoader); } } /** * A constructor for JCache. * <p/> * JCache is an adaptor for an Ehcache, and therefore requires an Ehcache in its constructor. * <p/> * @param cache An ehcache * @param cacheLoader used to load entries when they are not in the cache. If this is null, it is * set for the cache. If null, the JCache will inherit the CacheLoader set for the backing ehcache. * If specified, the underlying ehcache will have it's loader replaced. * @since 1.3 * @see "class description for recommended usage" */ public JCache(Ehcache cache, CacheLoader cacheLoader) { this.cache = cache; if (cacheLoader != null) { cache.setCacheLoader(cacheLoader); } } /** * Setter for the CacheLoader. Changing the CacheLoader takes immediate effect. * * @param cacheLoader the loader to dynamically load new cache entries. This replaces the CacheLoader in the underlying ehcache. */ public void setCacheLoader(CacheLoader cacheLoader) { cache.setCacheLoader(cacheLoader); } /** * Add a listener to the list of cache listeners. The behaviour of JCACHE and Ehcache listeners is a little * different. See {@link JCacheListenerAdaptor} for details on how each event is adapted. * * @param cacheListener a JCACHE CacheListener * @see JCacheListenerAdaptor */ public void addListener(CacheListener cacheListener) { JCacheListenerAdaptor cacheListenerAdaptor = new JCacheListenerAdaptor(cacheListener); cache.getCacheEventNotificationService().registerListener(cacheListenerAdaptor); } /** * The evict method will remove objects from the cache that are no longer valid. * Objects where the specified expiration time has been reached. * <p/> * This implementation synchronously checks each store for expired elements. Note that the DiskStore * has an expiryThread that runs periodically to do the same thing, and that the MemoryStore lazily checks * for expiry on overflow and peek, thus reducing the utility of calling this method. */ public void evict() { cache.evictExpiredElements(); } /** * The getAll method will return, from the cache, a Map of the objects associated with the Collection of keys in argument "keys". * If the objects are not in the cache, the associated cache loader will be called. If no loader is associated with an object, * a null is returned. If a problem is encountered during the retrieving or loading of the objects, an exception will be thrown. * If the "arg" argument is set, the arg object will be passed to the CacheLoader.loadAll method. The cache will not dereference * the object. If no "arg" value is provided a null will be passed to the loadAll method. The storing of null values in the cache * is permitted, however, the get method will not distinguish returning a null stored in the cache and not finding the object in * the cache. In both cases a null is returned. * <p/> * The Ehcache native API provides similar functionality to loaders using the * decorator {@link net.sf.ehcache.constructs.blocking.SelfPopulatingCache} * <p/> * Note. If the getAll exceeds the maximum cache * size, the returned map will necessarily be less than the number specified. * * @param keys * @return a Map populated from the Cache. If there are no elements, an empty Map is returned. */ public Map getAll(Collection keys) throws CacheException { return getAll(keys, null); } /** * The getAll method will return, from the cache, a Map of the objects associated with the Collection of keys in argument "keys". * If the objects are not in the cache, the associated cache loader will be called. If no loader is associated with an object, * a null is returned. If a problem is encountered during the retrieving or loading of the objects, an exception will be thrown. * If the "arg" argument is set, the arg object will be passed to the CacheLoader.loadAll method. The cache will not dereference * the object. If no "arg" value is provided a null will be passed to the loadAll method. The storing of null values in the cache * is permitted, however, the get method will not distinguish returning a null stored in the cache and not finding the object in * the cache. In both cases a null is returned. * <p/> * The Ehcache native API provides similar functionality to loaders using the * decorator {@link net.sf.ehcache.constructs.blocking.SelfPopulatingCache} * <p/> * Note. If the getAll exceeds the maximum cache * size, the returned map will necessarily be less than the number specified. * * @param keys * @return a Map populated from the Cache. If there are no elements, an empty Map is returned. */ public Map getAll(Collection keys, Object loaderArgument) throws CacheException { return cache.getAllWithLoader(keys, loaderArgument); } /** * Gets the CacheLoader registered in this cache * * @return the loader, or null if there is none */ public CacheLoader getCacheLoader() { return cache.getCacheLoader(); } /** * returns the CacheEntry object associated with the key. * * @param key the key to look for in the cache */ public CacheEntry getCacheEntry(Object key) { Element element = cache.get(key); if (element != null) { return new net.sf.ehcache.jcache.JCacheEntry(element); } else { return null; } } /** * Gets an immutable Statistics object representing the Cache statistics at the time. How the statistics are calculated * depends on the statistics accuracy setting. The only aspect of statistics sensitive to the accuracy setting is * object size. How that is calculated is discussed below. * <h3>Best Effort Size</h3> * This result is returned when the statistics accuracy setting is {@link CacheStatistics#STATISTICS_ACCURACY_BEST_EFFORT}. * <p/> * The size is the number of {@link Element}s in the {@link net.sf.ehcache.store.MemoryStore} plus * the number of {@link Element}s in the {@link net.sf.ehcache.store.DiskStore}. * <p/> * This number is the actual number of elements, including expired elements that have * not been removed. Any duplicates between stores are accounted for. * <p/> * Expired elements are removed from the the memory store when * getting an expired element, or when attempting to spool an expired element to * disk. * <p/> * Expired elements are removed from the disk store when getting an expired element, * or when the expiry thread runs, which is once every five minutes. * <p/> * <h3>Guaranteed Accuracy Size</h3> * This result is returned when the statistics accuracy setting is {@link CacheStatistics#STATISTICS_ACCURACY_GUARANTEED}. * <p/> * This method accounts for elements which might be expired or duplicated between stores. It take approximately * 200ms per 1000 elements to execute. * <h3>Fast but non-accurate Size</h3> * This result is returned when the statistics accuracy setting is {@link CacheStatistics#STATISTICS_ACCURACY_NONE}. * <p/> * The number given may contain expired elements. In addition if the DiskStore is used it may contain some double * counting of elements. It takes 6ms for 1000 elements to execute. Time to execute is O(log n). 50,000 elements take * 36ms. * * @return the number of elements in the ehcache, with a varying degree of accuracy, depending on accuracy setting. * @throws IllegalStateException if the cache is not {@link net.sf.ehcache.Status#STATUS_ALIVE} */ public CacheStatistics getCacheStatistics() throws IllegalStateException { return new JCacheStatistics(cache.getStatistics()); } /** * The load method provides a means to "pre load" the cache. This method will, asynchronously, load the specified * object into the cache using the associated cacheloader. If the object already exists in the cache, no action is * taken. If no loader is associated with the object, no object will be loaded into the cache. If a problem is * encountered during the retrieving or loading of the object, an exception should be logged. If the "arg" argument * is set, the arg object will be passed to the CacheLoader.load method. The cache will not dereference the object. * If no "arg" value is provided a null will be passed to the load method. The storing of null values in the cache * is permitted, however, the get method will not distinguish returning a null stored in the cache and not finding * the object in the cache. In both cases a null is returned. * <p/> * The Ehcache native API provides similar functionality to loaders using the * decorator {@link net.sf.ehcache.constructs.blocking.SelfPopulatingCache} * * @param key key whose associated value to be loaded using the associated cacheloader if this cache doesn't contain it. */ public void load(final Object key) throws CacheException { cache.load(key); } /** * The loadAll method provides a means to "pre load" objects into the cache. This method will, asynchronously, load * the specified objects into the cache using the associated cache loader. If the an object already exists in the * cache, no action is taken. If no loader is associated with the object, no object will be loaded into the cache. * If a problem is encountered during the retrieving or loading of the objects, an exception (to be defined) * should be logged. The getAll method will return, from the cache, a Map of the objects associated with the * Collection of keys in argument "keys". If the objects are not in the cache, the associated cache loader will be * called. If no loader is associated with an object, a null is returned. If a problem is encountered during the * retrieving or loading of the objects, an exception (to be defined) will be thrown. If the "arg" argument is set, * the arg object will be passed to the CacheLoader.loadAll method. The cache will not dereference the object. * If no "arg" value is provided a null will be passed to the loadAll method. * <p/> * keys - collection of the keys whose associated values to be loaded into this cache by using the associated * cacheloader if this cache doesn't contain them. * <p/> * The Ehcache native API provides similar functionality to loaders using the * decorator {@link net.sf.ehcache.constructs.blocking.SelfPopulatingCache} */ public void loadAll(final Collection keys) throws CacheException { loadAll(keys, null); } /** * The loadAll method provides a means to "pre load" objects into the cache. This method will, asynchronously, load * the specified objects into the cache using the associated cache loader. If the an object already exists in the * cache, no action is taken. If no loader is associated with the object, no object will be loaded into the cache. * If a problem is encountered during the retrieving or loading of the objects, an exception (to be defined) * should be logged. The getAll method will return, from the cache, a Map of the objects associated with the * Collection of keys in argument "keys". If the objects are not in the cache, the associated cache loader will be * called. If no loader is associated with an object, a null is returned. If a problem is encountered during the * retrieving or loading of the objects, an exception (to be defined) will be thrown. If the "arg" argument is set, * the arg object will be passed to the CacheLoader.loadAll method. The cache will not dereference the object. * If no "arg" value is provided a null will be passed to the loadAll method. * <p/> * keys - collection of the keys whose associated values to be loaded into this cache by using the associated * cacheloader if this cache doesn't contain them. * <p/> * The Ehcache native API provides similar functionality to loaders using the * decorator {@link net.sf.ehcache.constructs.blocking.SelfPopulatingCache} */ public void loadAll(final Collection keys, final Object argument) throws CacheException { cache.loadAll(keys, argument); } /** * The peek method will return the object associated with "key" if it currently exists (and is valid) in the cache. * If not, a null is returned. With "peek" the CacheLoader will not be invoked and other caches in the system will not be searched. * <p/> * In ehcache peek bahaves the same way as {@link #get} * * @param key * @return the value stored in the cache by key, or null if it does not exist */ public Object peek(Object key) { Element element = cache.get(key); if (element != null) { return element.getObjectValue(); } else { return null; } } /** * Remove a listener from the list of cache listeners * * @param cacheListener a JCACHE CacheListener * @see JCacheListenerAdaptor */ public void removeListener(CacheListener cacheListener) { JCacheListenerAdaptor cacheListenerAdaptor = new JCacheListenerAdaptor(cacheListener); cache.getCacheEventNotificationService().unregisterListener(cacheListenerAdaptor); } /** * Returns the number of key-value mappings in this map. If the * map contains more than <tt>Integer.MAX_VALUE</tt> elements, returns * <tt>Integer.MAX_VALUE</tt>. * * @return the number of key-value mappings in this map. */ public int size() { return cache.getSize(); } /** * Returns <tt>true</tt> if this map contains no key-value mappings. * * @return <tt>true</tt> if this map contains no key-value mappings. */ public boolean isEmpty() { return (size() == 0); } /** * Returns <tt>true</tt> if this map contains a mapping for the specified * key. More formally, returns <tt>true</tt> if and only if * this map contains a mapping for a key <tt>k</tt> such that * <tt>(key==null ? k==null : key.equals(k))</tt>. (There can be * at most one such mapping.) * * @param key key whose presence in this map is to be tested. * @return <tt>true</tt> if this map contains a mapping for the specified * key. */ public boolean containsKey(Object key) { return cache.isKeyInCache(key); } /** * Returns <tt>true</tt> if this map maps one or more keys to the * specified value. More formally, returns <tt>true</tt> if and only if * this map contains at least one mapping to a value <tt>v</tt> such that * <tt>(value==null ? v==null : value.equals(v))</tt>. This operation * will probably require time linear in the map size for most * implementations of the <tt>Map</tt> interface. * <p/> * Warning: This method is extremely slow. Ehcache is designed for efficient * retrieval using keys, not values. * * @param value value whose presence in this map is to be tested. * @return <tt>true</tt> if this map maps one or more keys to the * specified value. */ public boolean containsValue(Object value) { long start = System.currentTimeMillis(); boolean inCache = cache.isValueInCache(value); long end = System.currentTimeMillis(); if (LOG.isLoggable(Level.WARNING)) { LOG.warning("Performance Warning: containsValue is not recommended. This call took " + (end - start) + " ms"); } return inCache; } /** * The get method will return, from the cache, the object associated with * the argument "key". * <p/> * If the object is not in the cache, the associated * cache loader will be called. If no loader is associated with the object, * a null is returned. * <p/> * If a problem is encountered during the retrieving * or loading of the object, an exception (to be defined) will be thrown. (Until it is * defined, the ehcache implementation throws a RuntimeException.) * <p/> * If the "arg" argument is set, the arg object will be passed to the * CacheLoader.load method. The cache will not dereference the object. * If no "arg" value is provided a null will be passed to the load method. * <p/> * The storing of null values in the cache is permitted, however, the get * method will not distinguish returning a null stored in the cache and * not finding the object in the cache. In both cases a null is returned. * <p/> * Cache statistics are only updated for the initial attempt to get the cached entry. * * @param key key whose associated value is to be returned. * @return the value to which this map maps the specified key, or * <tt>null</tt> if the map contains no mapping for this key after an attempt has been * made to load it. * @throws RuntimeException JSR107 should really throw a CacheException here, but the * spec does not allow it. Instead throw a RuntimeException if the underlying load method * throws a CacheException. * @see #containsKey(Object) */ public Object get(Object key) throws RuntimeException { return get(key, null); } /** * Same as {@link #get(Object)} except a CacheLoader argument is provided. * * @param key key whose associated value is to be returned. * @param loaderArgument anything at all that a CacheLoader might find useful to load * the entry. If the loaderArgument is null, this method is the same as {@link #get(Object)} * @return the value to which this map maps the specified key, or * <tt>null</tt> if the map contains no mapping for this key after an attempt has been * made to load it. * @throws RuntimeException JSR107 should really throw a CacheException here, but the * spec does not allow it. Instead throw a RuntimeException if the underlying load method * throws a CacheException. */ public Object get(Object key, Object loaderArgument) throws RuntimeException { return get(key, null, loaderArgument); } /** * The get method will return, from the cache, the object associated with * the argument "key". * <p/> * If the object is not in the cache, the associated * cache loader will be called. If no loader is associated with the object, * a null is returned. * <p/> * If a problem is encountered during the retrieving * or loading of the object, an exception (to be defined) will be thrown. (Until it is * defined, the ehcache implementation throws a RuntimeException.) * <p/> * If the "argument" argument is set, the arg object will be passed to the * CacheLoader.load method. The cache will not dereference the object. * If no "argument" value is provided a null will be passed to the load method. * <p/> * The storing of null values in the cache is permitted, however, the get * method will not distinguish returning a null stored in the cache and * not finding the object in the cache. In both cases a null is returned. * <p/> * Cache statistics are only updated for the initial attempt to get the cached entry. * * @param key key whose associated value is to be returned. * @param loader A specific CacheLoader to use in place of the default one. * @return the value to which this map maps the specified key, or * <tt>null</tt> if the map contains no mapping for this key after an attempt has been * made to load it. * @throws RuntimeException JSR107 should really throw a CacheException here, but the * spec does not allow it. Instead throw a RuntimeException if the underlying load method * throws a CacheException. * @see #containsKey(Object) */ public Object get(Object key, CacheLoader loader) throws RuntimeException { return get(key, loader, null); } /** * The get method will return, from the cache, the object associated with * the argument "key". * <p/> * If the object is not in the cache, the associated * cache loader will be called. If no loader is associated with the object, * a null is returned. * <p/> * If a problem is encountered during the retrieving * or loading of the object, an exception (to be defined) will be thrown. (Until it is * defined, the ehcache implementation throws a RuntimeException.) * <p/> * If the "loaderArgument" argument is set, it will be passed to the * CacheLoader.load method. The cache will not dereference the object. * If no "loaderArgument" value is provided a null will be passed to the load method. * <p/> * The storing of null values in the cache is permitted, however, the get * method will not distinguish returning a null stored in the cache and * not finding the object in the cache. In both cases a null is returned. * <p/> * Cache statistics are only updated for the initial attempt to get the cached entry. * * @param key key whose associated value is to be returned. * @param loader A specific CacheLoader to use in place of the default one. * @param loaderArgument an Object with acts as a loaderArgument. It can contain anything that makes sense to the loader. * @return the value to which this map maps the specified key, or * <tt>null</tt> if the map contains no mapping for this key after an attempt has been * made to load it. * @throws RuntimeException JSR107 should really throw a CacheException here, but the * spec does not allow it. Instead throw a RuntimeException if the underlying load method * throws a CacheException. * @see #containsKey(Object) */ public Object get(Object key, CacheLoader loader, Object loaderArgument) throws RuntimeException { Element element = cache.getWithLoader(key, loader, loaderArgument); if (element == null) { return null; } else { return element.getObjectValue(); } } /** * Associates the specified value with the specified key in this map * (optional operation). If the map previously contained a mapping for * this key, the old value is replaced by the specified value. (A map * <tt>m</tt> is said to contain a mapping for a key <tt>k</tt> if and only * if {@link #containsKey(Object) m.containsKey(k)} would return * <tt>true</tt>.)) * * @param key key with which the specified value is to be associated. * @param value value to be associated with the specified key. * @return previous value associated with specified key, or <tt>null</tt> * if there was no mapping for key. A <tt>null</tt> return can * also indicate that the map previously associated <tt>null</tt> * with the specified key, if the implementation supports * <tt>null</tt> values. */ public Object put(Object key, Object value) { return put(key, value, 0); } /** * Associates the specified value with the specified key in this map * (optional operation). If the map previously contained a mapping for * this key, the old value is replaced by the specified value. (A map * <tt>m</tt> is said to contain a mapping for a key <tt>k</tt> if and only * if {@link #containsKey(Object) m.containsKey(k)} would return * <tt>true</tt>.)) * * @param key key with which the specified value is to be associated. * @param value value to be associated with the specified key. * @param timeToLiveSeconds the time this entry will live, overriding the default. If timeToLive * is set to 0, the default will be applied. * @return previous value associated with specified key, or <tt>null</tt> * if there was no mapping for key. A <tt>null</tt> return can * also indicate that the map previously associated <tt>null</tt> * with the specified key, if the implementation supports * <tt>null</tt> values. */ public Object put(Object key, Object value, int timeToLiveSeconds) { Element element = null; if (cache.isKeyInCache(key)) { element = cache.getQuiet(key); } Element newElement = new Element(key, value); if (timeToLiveSeconds != 0) { newElement.setTimeToLive(timeToLiveSeconds); } cache.put(newElement); if (element != null) { return element.getObjectValue(); } else { return null; } } /** * Removes the mapping for this key from this map if it is present * (optional operation). More formally, if this map contains a mapping * from key <tt>k</tt> to value <tt>v</tt> such that * <code>(key==null ? k==null : key.equals(k))</code>, that mapping * is removed. (The map can contain at most one such mapping.) * <p/> * <p>Returns the value to which the map previously associated the key, or * <tt>null</tt> if the map contained no mapping for this key. (A * <tt>null</tt> return can also indicate that the map previously * associated <tt>null</tt> with the specified key if the implementation * supports <tt>null</tt> values.) The map will not contain a mapping for * the specified key once the call returns. * * @param key key whose mapping is to be removed from the map. * @return previous value associated with specified key, or <tt>null</tt> * if there was no mapping for key. */ public Object remove(Object key) { Element element = cache.get(key); cache.remove(key); if (element != null) { return element.getObjectValue(); } else { return null; } } /** * Copies all of the mappings from the specified map to this map * (optional operation). The effect of this call is equivalent to that * of calling {@link #put(Object,Object) put(k, v)} on this map once * for each mapping from key <tt>k</tt> to value <tt>v</tt> in the * N specified map. The behavior of this operation is unspecified if the * specified map is modified while the operation is in progress. * * @param sourceMap Mappings to be stored in this map. */ public void putAll(Map sourceMap) { if (sourceMap == null) { return; } for (Iterator iterator = sourceMap.keySet().iterator(); iterator.hasNext();) { Object key = iterator.next(); cache.put(new Element(key, sourceMap.get(key))); } } /** * Removes all mappings from this map (optional operation). */ public void clear() { cache.removeAll(); } /** * Returns a set view of the keys contained in this map. The set is * not live because ehcache is not backed by a simple map. * * @return a set view of the keys contained in this map. */ public Set keySet() { List list = cache.getKeys(); Set set = new HashSet(); set.addAll(list); return set; } /** * Returns a collection view of the values contained in this map. The * collection is backed by the map, so changes to the map are reflected in * the collection, and vice-versa. If the map is modified while an * iteration over the collection is in progress (except through the * iterator's own <tt>remove</tt> operation), the results of the * iteration are undefined. The collection supports element removal, * which removes the corresponding mapping from the map, via the * <tt>Iterator.remove</tt>, <tt>Collection.remove</tt>, * <tt>removeAll</tt>, <tt>retainAll</tt> and <tt>clear</tt> operations. * It does not support the add or <tt>addAll</tt> operations. * <p/> * Contradicting the above Map contract, whether cache changes after this method returns are not * reflected in the Collection. This is because ehcache is not backed by a single map. * * @return a collection view of the values contained in this map. */ public Collection values() { List list = cache.getKeysNoDuplicateCheck(); Set set = new HashSet(list.size()); for (int i = 0; i < list.size(); i++) { Object key = list.get(i); Element element = cache.get(key); if (element != null) { set.add(element.getObjectValue()); } } return set; } /** * Returns a set view of the mappings contained in this map. Each element * in the returned set is a {@link java.util.Map.Entry}. The set is backed by the * map, so changes to the map are reflected in the set, and vice-versa. * If the map is modified while an iteration over the set is in progress * (except through the iterator's own <tt>remove</tt> operation, or through * the <tt>setValue</tt> operation on a map entry returned by the iterator) * the results of the iteration are undefined. The set supports element * removal, which removes the corresponding mapping from the map, via the * <tt>Iterator.remove</tt>, <tt>Set.remove</tt>, <tt>removeAll</tt>, * <tt>retainAll</tt> and <tt>clear</tt> operations. It does not support * the <tt>add</tt> or <tt>addAll</tt> operations. * <p/> * Contradicting the above Map contract, whether or not changes to an entry affect the entry in the cache is undefined. * * @return a set view of the mappings contained in this map. */ public Set entrySet() { List list = cache.getKeysNoDuplicateCheck(); Set set = new HashSet(list.size()); for (int i = 0; i < list.size(); i++) { Object key = list.get(i); Element element = cache.get(key); if (element != null) { set.add(new net.sf.ehcache.jcache.JCacheEntry(element)); } } return set; } /** * Sets the statistics accuracy. * * @param statisticsAccuracy one of {@link CacheStatistics#STATISTICS_ACCURACY_BEST_EFFORT}, {@link CacheStatistics#STATISTICS_ACCURACY_GUARANTEED}, {@link CacheStatistics#STATISTICS_ACCURACY_NONE} */ public void setStatisticsAccuracy(int statisticsAccuracy) { cache.setStatisticsAccuracy(statisticsAccuracy); } /** * Gets the backing Ehcache */ public Ehcache getBackingCache() { return cache; } /** * Returns a {@link String} representation of the underlying {@link net.sf.ehcache.Cache}. * * @return a string representation of the object. */ public String toString() { return cache.toString(); } }

The table below shows all metrics for JCache.java.

MetricValueDescription
BLOCKS56.00Number of blocks
BLOCK_COMMENT 0.00Number of block comment lines
COMMENTS510.00Comment lines
COMMENT_DENSITY 3.42Comment density
COMPARISONS17.00Number of comparison operators
CYCLOMATIC51.00Cyclomatic complexity
DECL_COMMENTS38.00Comments in declarations
DOC_COMMENT510.00Number of javadoc comment lines
ELOC149.00Effective lines of code
EXEC_COMMENTS 0.00Comments in executable code
EXITS45.00Procedure exits
FUNCTIONS35.00Number of function declarations
HALSTEAD_DIFFICULTY44.33Halstead difficulty
HALSTEAD_EFFORT 0.00Halstead effort
INTERFACE_COMPLEXITY113.00Interface complexity
JAVA0001 0.00JAVA0001 Package name does not contain only lower case letters
JAVA0002 0.00JAVA0002 Package name does not begin with a top level domain name or country code
JAVA0003 0.00JAVA0003 Minimize use of on-demand (.*) imports
JAVA0004 0.00JAVA0004 Unnecessary import from java.lang
JAVA0005 1.00JAVA0005 Imports not in specified order
JAVA0006 0.00JAVA0006 Empty finally block
JAVA0007 0.00JAVA0007 Should not declare public field
JAVA0008 0.00JAVA0008 Empty catch block
JAVA0009 0.00JAVA0009 Protected member in final class
JAVA0010 0.00JAVA0010 Non-instantiable class does not contain a non-private static member
JAVA0011 0.00JAVA0011 Abstract class does not contain an abstract method
JAVA0012 0.00JAVA0012 Non-constructor method with same name as declaring class
JAVA0013 0.00JAVA0013 Non-blank final field is not static
JAVA0014 0.00JAVA0014 Class with only static members has non-private constructor
JAVA0015 0.00JAVA0015 Package class contains public nested type
JAVA0016 0.00JAVA0016 Abstract class contains public constructor
JAVA0017 0.00JAVA0017 Class name does not have required form
JAVA0018 0.00JAVA0018 Method name does not have required form
JAVA0019 0.00JAVA0019 Interface name does not have required form
JAVA0020 0.00JAVA0020 Field name does not have required form
JAVA0021 0.00JAVA0021 Interface method name does not have required form
JAVA0022 0.00JAVA0022 Static final field name does not have required form
JAVA0023 0.00JAVA0023 Empty finalize method
JAVA0024 0.00JAVA0024 Empty class
JAVA0025 0.00JAVA0025 Method override is empty
JAVA0026 0.00JAVA0026 Finalize method with parameters
JAVA0029 0.00JAVA0029 Private method not used
JAVA0030 0.00JAVA0030 Private field not used
JAVA0031 0.00JAVA0031 Case statement not properly closed
JAVA0032 0.00JAVA0032 Switch statement missing default
JAVA0033 0.00JAVA0033 default: not last case in switch statement
JAVA0034 0.00JAVA0034 Missing braces in if statement
JAVA0035 0.00JAVA0035 Missing braces in for statement
JAVA0036 0.00JAVA0036 Missing braces in while statement
JAVA0038 0.00JAVA0038 Non-case label in switch statement
JAVA0039 0.00JAVA0039 Break statement with label
JAVA0040 0.00JAVA0040 Switch statement contains N cases (maximum: M)
JAVA0041 0.00JAVA0041 Nested synchronized block
JAVA0042 0.00JAVA0042 Empty synchronized statement
JAVA0043 0.00JAVA0043 Inner class does not use outer class
JAVA0044 0.00JAVA0044 Serializable class with no instance variables
JAVA0045 0.00JAVA0045 Serializable class with only transient fields
JAVA0046 0.00JAVA0046 Name of class not derived from Exception ends with 'Exception'
JAVA0047 0.00JAVA0047 Serializable class derives from invalid base class
JAVA0048 0.00JAVA0048 Name of class derived from Exception does not end with 'Exception'
JAVA0049 0.00JAVA0049 Nested block at depth N (maximum: M)
JAVA0050 0.00JAVA0050 Class derives from java.lang.Error
JAVA0051 0.00JAVA0051 Class derives from java.lang.RuntimeException
JAVA0052 0.00JAVA0052 Class derives from java.lang.Throwable
JAVA0053 0.00JAVA0053 Unused label
JAVA0054 0.00JAVA0054 Inheritance depth N exceeds maximum M
JAVA0055 0.00JAVA0055 Class should be interface
JAVA0056 0.00JAVA0056 Unnecessary abstract modifier for interface or annotation
JAVA0057 0.00JAVA0057 Unnecessary default constructor
JAVA0058 0.00JAVA0058 Constructor calls super()
JAVA0059 0.00JAVA0059 Method override only calls super()
JAVA0061 0.00JAVA0061 Inaccessible member in anonymous class
JAVA0062 0.00JAVA0062 Public class missing public member or protected constructor
JAVA0063 0.00JAVA0063 Identifier name should not contain '$'
JAVA0064 0.00JAVA0064 N variations of identifier name (maximum: M)
JAVA0065 0.00JAVA0065 Unnecessary final modifier for method in final class
JAVA0066 0.00JAVA0066 Unnecessary modifier for interface nested type
JAVA0067 0.00JAVA0067 Array descriptor on identifier name
JAVA0068 0.00JAVA0068 Modifiers not declared in recommended order
JAVA0071 0.00JAVA0071 Strings compared with ==
JAVA0073 0.00JAVA0073 Integer division in floating-point context
JAVA0074 0.00JAVA0074 Use of Object.notify()
JAVA0075 0.00JAVA0075 Method parameter hides field
JAVA0076 0.00JAVA0076 Use of magic number
JAVA0077 0.00JAVA0077 Private field not used in declaring class
JAVA0078 0.00JAVA0078 Floating point values compared with ==
JAVA0079 0.00JAVA0079 Use of instance to reference static member
JAVA0080 0.00JAVA0080 Import declaration not used
JAVA0081 0.00JAVA0081 Boolean literal in comparison
JAVA0082 0.00JAVA0082 Unnecessary widening cast
JAVA0083 0.00JAVA0083 Unnecessary instanceof test
JAVA0084 0.00JAVA0084 Should use compound assignment operator
JAVA0085 0.00JAVA0085 Use of sun.* class
JAVA0087 0.00JAVA0087 Use of Thread.sleep()
JAVA0089 0.00JAVA0089 Use of restricted package
JAVA0092 0.00JAVA0092 Use of restricted type
JAVA0093 0.00JAVA0093 Redundant assignment
JAVA0094 0.00JAVA0094 Field hides a superclass field
JAVA0095 0.00JAVA0095 Uninitialized private field
JAVA0096 0.00JAVA0096 Field in nested class hides outer field
JAVA0098 0.00JAVA0098 Minimize use of implicit field initializers
JAVA0100 0.00JAVA0100 Class contains N non-final fields (maximum: M)
JAVA0101 0.00JAVA0101 Unnecessary modifier for field in interface
JAVA0102 0.00JAVA0102 Last statement in finalize() not super.finalize()
JAVA0103 0.00JAVA0103 Explicit call to finalize()
JAVA0104 0.00JAVA0104 finalize() only calls super.finalize()
JAVA0105 0.00JAVA0105 Duplicate import declaration
JAVA0106 0.00JAVA0106 Unnecessary import from current package
JAVA0108 3.00JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
JAVA0109 0.00JAVA0109 Incorrect javadoc: no parameter 'parameter'
JAVA0110 2.00JAVA0110 Incorrect javadoc: no @return tag
JAVA0111 0.00JAVA0111 Incorrect javadoc: @return tag for void method
JAVA0112 0.00JAVA0112 Incorrect javadoc: no exception 'exception' in throws
JAVA0113 0.00JAVA0113 Incorrect javadoc: no @author tag
JAVA0114 0.00JAVA0114 Incorrect javadoc: no @version tag
JAVA0115 5.00JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception'
JAVA0116 0.00JAVA0116 Missing javadoc: field 'field'
JAVA0117 0.00JAVA0117 Missing javadoc: method 'method'
JAVA0118 0.00JAVA0118 Missing javadoc: type 'type'
JAVA0119 0.00JAVA0119 Control variable changed within body of for loop
JAVA0123 0.00JAVA0123 Use all three components of for loop
JAVA0125 0.00JAVA0125 Continue statement with label
JAVA0126 5.00JAVA0126 Method declares unchecked exception in throws
JAVA0128 0.00JAVA0128 Public constructor in non-public class
JAVA0130 0.00JAVA0130 Non-static method does not use instance fields
JAVA0131 0.00JAVA0131 Compatible method does not override base
JAVA0132 1.00JAVA0132 Method overload with compatible signature
JAVA0133 0.00JAVA0133 Non-synchronized method overrides synchronized method
JAVA0135 0.00JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method'
JAVA0136 1.00JAVA0136 N methods defined in class (maximum: M)
JAVA0137 0.00JAVA0137 Non-abstract class missing constructor
JAVA0138 0.00JAVA0138 N parameters defined for method (maximum: M)
JAVA0139 0.00JAVA0139 Definition of main other than public static void main(java.lang.String[])
JAVA0141 0.00JAVA0141 Unnecessary modifier for method in interface
JAVA0143 0.00JAVA0143 Synchronized method
JAVA0144 9.00JAVA0144 Line exceeds maximum M characters
JAVA0145 0.00JAVA0145 Tab character used in source file
JAVA0150 0.00JAVA0150 java.lang.Error (or subclass) thrown
JAVA0153 0.00JAVA0153 Inefficient conversion of integer to string
JAVA0159 0.00JAVA0159 Inefficient conversion of string to integer
JAVA0160 2.00JAVA0160 Method does not throw specified exception
JAVA0161 0.00JAVA0161 Conditional wait() not in loop
JAVA0163 0.00JAVA0163 Empty statement
JAVA0165 0.00JAVA0165 Conflicting return statement in finally block
JAVA0166 0.00JAVA0166 Generic exception caught
JAVA0167 0.00JAVA0167 ThreadDeath not rethrown
JAVA0169 0.00JAVA0169 Unnecessary catch block: exception 'exception'
JAVA0170 0.00JAVA0170 Caught exception not derived from java.lang.Exception
JAVA0171 0.00JAVA0171 Unused local variable
JAVA0173 0.00JAVA0173 Unused method parameter
JAVA0174 0.00JAVA0174 Assigned local variable never used
JAVA0175 0.00JAVA0175 Successive assignment to variable
JAVA0176 0.00JAVA0176 Local variable name does not have required form
JAVA0177 0.00JAVA0177 Variable declaration missing initializer
JAVA0179 0.00JAVA0179 Local variable hides visible field
JAVA0233 0.00JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID'
JAVA0234 0.00JAVA0234 Class is Serializable but does not define serialVersionUID
JAVA0235 0.00JAVA0235 Class defines serialVersionUID but does not implement Serializable
JAVA0236 0.00JAVA0236 Attempt to clone an object which does not implement Cloneable
JAVA0237 0.00JAVA0237 Class implements Cloneable but does not have public clone method
JAVA0238 0.00JAVA0238 Clone method does not call super.clone()
JAVA0239 0.00JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable
JAVA0240 0.00JAVA0240 Serializable class which declares readObject or writeObject but not both
JAVA0241 0.00JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class
JAVA0242 0.00JAVA0242 Transient field in non-Serializable class
JAVA0243 0.00JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected
JAVA0244 0.00JAVA0244 Field or method name in subclass differs only by case from inherited field or method
JAVA0245 0.00JAVA0245 JUnit TestCase with non-trivial constructor
JAVA0246 0.00JAVA0246 JUnit assertXXX statement missing message parameter
JAVA0247 0.00JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method
JAVA0248 0.00JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature
JAVA0249 0.00JAVA0249 JUnit TestCase 'suite()' should be declared static
JAVA0250 0.00JAVA0250 JUnit TestCase declares testXXX method with incorrect signature
JAVA0251 0.00JAVA0251 Use '%n' for line breaks in printf/format for platform independence
JAVA0252 0.00JAVA0252 'enum' is a Java 1.5 reserved word
JAVA0253 0.00JAVA0253 Not all enum constants consumed in switch statement
JAVA0254 1.00JAVA0254 Use enhanced for loop construct instead of Iterator
JAVA0255 0.00JAVA0255 Result of method invocation not used
JAVA0256 0.00JAVA0256 Assignment of external collection/array to field
JAVA0257 0.00JAVA0257 Use of 'Constant Interface' anti-pattern
JAVA0258 0.00JAVA0258 Implement Iterable for foreach compatibility
JAVA0259 0.00JAVA0259 Return of collection/array field
JAVA0260 0.00JAVA0260 Use 'enum' instead of Enumerated Type pattern
JAVA0261 0.00JAVA0261 Use specialized Enum collection types
JAVA0262 0.00JAVA0262 Use of char in integer context
JAVA0263 0.00JAVA0263 Long literal ends with 'l' instead of 'L'
JAVA0264 0.00JAVA0264 Integer math in long context - check for overflow
JAVA0265 0.00JAVA0265 Use of Throwable.printStackTrace()
JAVA0266 0.00JAVA0266 Use of System.out
JAVA0267 0.00JAVA0267 Use of System.err
JAVA0269 0.00JAVA0269 Contents of StringBuffer never used
JAVA0270 0.00JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array
JAVA0271 0.00JAVA0271 Minimize use of on-demand (.*) static imports
JAVA0272 0.00JAVA0272 Thread.run() called
JAVA0273 0.00JAVA0273 Non-final derivative of Thread calls start() in constructor
JAVA0274 0.00JAVA0274 Serializable class has a synchronized readObject()
JAVA0275 0.00JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods
JAVA0276 0.00JAVA0276 Unnecessary use of String constructor
JAVA0277 0.00JAVA0277 Iterator.next() implementation does not throw NoSuchElementException
JAVA0278 0.00JAVA0278 Unnecessary use of Boolean constructor
JAVA0279 0.00JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method
JAVA0280 0.00JAVA0280 IllegalMonitorStateException caught
JAVA0281 0.00JAVA0281 Iterator.next() not called in loop
JAVA0282 0.00JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext()
JAVA0283 0.00JAVA0283 Control variable not updated in loop body
JAVA0284 0.00JAVA0284 Explicit garbage collection
JAVA0285 0.00JAVA0285 Dereference of potentially null variable
JAVA0286 0.00JAVA0286 Dereference of null variable
JAVA0287 0.00JAVA0287 Unnecessary null check
JAVA0288 0.00JAVA0288 Inconsistent null check
LINES770.00Number of lines in the source file
LINE_COMMENT 0.00Number of line comments
LOC201.00Lines of code
LOGICAL_LINES97.00Number of statements
LOOPS 3.00Number of loops
NEST_DEPTH 3.00Maximum nesting depth
OPERANDS472.00Number of operands
OPERATORS844.00Number of operators
PARAMS35.00Number of formal parameter declarations
PROGRAM_LENGTH1316.00Halstead program length
PROGRAM_VOCAB215.00Halstead program vocabulary
PROGRAM_VOLUME 0.00Halstead program volume
RETURNS78.00Number of return points from functions
SIZE36084.00Size of the file in bytes
UNIQUE_OPERANDS181.00Number of unique operands
UNIQUE_OPERATORS34.00Number of unique operators
WHITESPACE59.00Number of whitespace lines