Top Description Fields Constructors Methods
org.hibernate.cache.impl.bridge

public abstract Class BaseGeneralDataRegionAdapter

extends BaseRegionAdapter
implements GeneralDataRegion
Class Inheritance
All Implemented Interfaces
org.hibernate.cache.GeneralDataRegion, org.hibernate.cache.Region
Known Direct Subclasses
org.hibernate.cache.impl.bridge.QueryResultsRegionAdapter, org.hibernate.cache.impl.bridge.TimestampsRegionAdapter
Imports
org.hibernate.cache.GeneralDataRegion, .Cache, .CacheException, org.hibernate.cfg.Settings

Contract for general-purpose cache regions.
Author
Steve Ebersole

Field Summary

Inherited from org.hibernate.cache.impl.bridge.BaseRegionAdapter:
settingsunderlyingCache

Constructor Summary

AccessConstructor and Description
protected
BaseGeneralDataRegionAdapter(Cache underlyingCache, Settings settings)

Deprecated as a consequence of Cache being deprecated.

Method Summary

Modifier and TypeMethod and Description
public void
evict(Object
The key of the item to remove
key
)

Implements org.hibernate.cache.GeneralDataRegion.evict.

Evict an item from the cache immediately (without regard for transaction isolation).
public void
evictAll()

Implements org.hibernate.cache.GeneralDataRegion.evictAll.

Evict all contents of this particular cache region (without regard for transaction isolation).
public Object
get(Object
The key of the item to be retrieved.
key
)

Implements org.hibernate.cache.GeneralDataRegion.get.

Get an item from the cache.
public void
put(Object
The key under which to cache the item.
key
,
Object
The item to cache.
value
)

Implements org.hibernate.cache.GeneralDataRegion.put.

Put an item into the cache.
Inherited from org.hibernate.cache.impl.bridge.BaseRegionAdapter:
clearcontainsdestroygetElementCountInMemorygetElementCountOnDiskgetNamegetSizeInMemorygetTimeoutnextTimestamptoMap

Constructor Detail

BaseGeneralDataRegionAdapterback to summary
protected BaseGeneralDataRegionAdapter(Cache underlyingCache, Settings settings)

Deprecated

as a consequence of Cache being deprecated. See corresponding docs for further information.

Method Detail

evictback to summary
public void evict(Object key) throws CacheException

Implements org.hibernate.cache.GeneralDataRegion.evict.

Doc from org.hibernate.cache.GeneralDataRegion.evict.

Evict an item from the cache immediately (without regard for transaction isolation).

Parameters
key:Object

The key of the item to remove

Exceptions
CacheException:
Indicates a problem accessing the item or region.
evictAllback to summary
public void evictAll() throws CacheException

Implements org.hibernate.cache.GeneralDataRegion.evictAll.

Doc from org.hibernate.cache.GeneralDataRegion.evictAll.

Evict all contents of this particular cache region (without regard for transaction isolation).

Exceptions
CacheException:
Indicates problem accessing the region.
getback to summary
public Object get(Object key) throws CacheException

Implements org.hibernate.cache.GeneralDataRegion.get.

Doc from org.hibernate.cache.GeneralDataRegion.get.

Get an item from the cache.

Parameters
key:Object

The key of the item to be retrieved.

Returns:Object

the cached object or null

Exceptions
CacheException:
Indicates a problem accessing the item or region.
putback to summary
public void put(Object key, Object value) throws CacheException

Implements org.hibernate.cache.GeneralDataRegion.put.

Doc from org.hibernate.cache.GeneralDataRegion.put.

Put an item into the cache.

Parameters
key:Object

The key under which to cache the item.

value:Object

The item to cache.

Exceptions
CacheException:
Indicates a problem accessing the region.