Top Description Methods
org.hibernate.cache

public Interface GeneralDataRegion

extends Region
Known Direct Subinterfaces
org.hibernate.cache.QueryResultsRegion, org.hibernate.cache.TimestampsRegion
Known Direct Implementers
org.hibernate.cache.impl.bridge.BaseGeneralDataRegionAdapter

Contract for general-purpose cache regions.
Author
Steve Ebersole

Method Summary

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

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

public void
evictAll()

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

public Object

Returns:

the cached object or null
get
(Object
The key of the item to be retrieved.
key
)

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
)

Put an item into the cache.

Inherited from org.hibernate.cache.Region:
containsdestroygetElementCountInMemorygetElementCountOnDiskgetNamegetSizeInMemorygetTimeoutnextTimestamptoMap

Method Detail

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

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

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

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

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.