org.hibernate.cache.ehcache.internal.regions
Class EhcacheQueryResultsRegion

java.lang.Object
  extended by org.hibernate.cache.ehcache.internal.regions.EhcacheDataRegion
      extended by org.hibernate.cache.ehcache.internal.regions.EhcacheQueryResultsRegion
All Implemented Interfaces:
GeneralDataRegion, QueryResultsRegion, Region

public class EhcacheQueryResultsRegion
extends EhcacheDataRegion
implements QueryResultsRegion

A query results region specific wrapper around an Ehcache instance.


Field Summary
 
Fields inherited from class org.hibernate.cache.ehcache.internal.regions.EhcacheDataRegion
accessStrategyFactory, cache
 
Constructor Summary
EhcacheQueryResultsRegion(EhcacheAccessStrategyFactory accessStrategyFactory, net.sf.ehcache.Ehcache underlyingCache, Properties properties)
          Constructs an EhcacheQueryResultsRegion around the given underlying cache.
 
Method Summary
 void evict(Object key)
          Evict an item from the cache immediately (without regard for transaction isolation).
 void evictAll()
          Evict all contents of this particular cache region (without regard for transaction isolation).
 Object get(Object key)
          Get an item from the cache.
 void put(Object key, Object value)
          Put an item into the cache.
 
Methods inherited from class org.hibernate.cache.ehcache.internal.regions.EhcacheDataRegion
contains, destroy, getEhcache, getElementCountInMemory, getElementCountOnDisk, getName, getSizeInMemory, getTimeout, nextTimestamp, toMap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.hibernate.cache.spi.GeneralDataRegion
evict, evictAll, get, put
 
Methods inherited from interface org.hibernate.cache.spi.Region
contains, destroy, getElementCountInMemory, getElementCountOnDisk, getName, getSizeInMemory, getTimeout, nextTimestamp, toMap
 

Constructor Detail

EhcacheQueryResultsRegion

public EhcacheQueryResultsRegion(EhcacheAccessStrategyFactory accessStrategyFactory,
                                 net.sf.ehcache.Ehcache underlyingCache,
                                 Properties properties)
Constructs an EhcacheQueryResultsRegion around the given underlying cache.

Parameters:
accessStrategyFactory -
Method Detail

get

public Object get(Object key)
           throws CacheException
Get an item from the cache.

Specified by:
get in interface GeneralDataRegion
Parameters:
key - The key of the item to be retrieved.
Returns:
the cached object or null
Throws:
CacheException - Indicates a problem accessing the item or region.

put

public void put(Object key,
                Object value)
         throws CacheException
Put an item into the cache.

Specified by:
put in interface GeneralDataRegion
Parameters:
key - The key under which to cache the item.
value - The item to cache.
Throws:
CacheException - Indicates a problem accessing the region.

evict

public void evict(Object key)
           throws CacheException
Evict an item from the cache immediately (without regard for transaction isolation).

Specified by:
evict in interface GeneralDataRegion
Parameters:
key - The key of the item to remove
Throws:
CacheException - Indicates a problem accessing the item or region.

evictAll

public void evictAll()
              throws CacheException
Evict all contents of this particular cache region (without regard for transaction isolation).

Specified by:
evictAll in interface GeneralDataRegion
Throws:
CacheException - Indicates problem accessing the region.


Copyright © 2001-2013 Red Hat, Inc. All Rights Reserved.