Package org.hibernate.cache.spi
Interface Region
-
- All Known Subinterfaces:
DirectAccessRegion,DomainDataRegion,QueryResultsRegion,TimestampsRegion
- All Known Implementing Classes:
AbstractDomainDataRegion,AbstractRegion,DirectAccessRegionTemplate,DomainDataRegionImpl,DomainDataRegionTemplate,JCacheDomainDataRegionImpl,QueryResultsRegionTemplate,TimestampsRegionTemplate
public interface RegionContract for a named cache "region". A logical region might not necessarily correlate to any specific concept in the underlying caching provider - it's just a thing that can be referenced by name later.A region's name is "unqualified"; i.e. it is not prefixed by
SessionFactoryOptions.getCacheRegionPrefix().Regionis the base contract defining some common characteristics regardless of the type of data intended to be stored within the region. The more specific subtypes are:DomainDataRegionfor storing entity, collection and natural-id data andDirectAccessRegionfor storing query result and timestamp data.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidclear()Clear all data cached in the regionvoiddestroy()The "end state" contract of the region's lifecycle.StringgetName()Retrieve the unqualified name of this region.RegionFactorygetRegionFactory()The RegionFactory that generated this Region
-
-
-
Method Detail
-
getName
String getName()
Retrieve the unqualified name of this region.
-
getRegionFactory
RegionFactory getRegionFactory()
The RegionFactory that generated this Region
-
clear
void clear()
Clear all data cached in the region
-
destroy
void destroy() throws CacheExceptionThe "end state" contract of the region's lifecycle. Called duringSessionFactory.close()to give the region a chance to cleanup.- Throws:
CacheException- Indicates problem shutting down
-
-