org.hibernate.cache.spi

Interface CacheDataDescription

All Known Implementing Classes:

CacheDataDescriptionImpl

public interface CacheDataDescription

Describes attributes regarding the type of data to be cached.

Author:

Steve Ebersole

Method Summary

Modifier and Type	Method and Description
Type	getKeyType()
Comparator	getVersionComparator() Get the comparator used to compare two different version values.
boolean	isMutable() Is the data marked as being mutable?
boolean	isVersioned() Is the data to be cached considered versioned? If true, it is illegal for getVersionComparator() to return null or an instance of IncomparableComparator.

Method Detail

isMutable

boolean isMutable()

Is the data marked as being mutable?

Returns:

true if the data is mutable; false otherwise.

isVersioned

boolean isVersioned()

Is the data to be cached considered versioned? If true, it is illegal for getVersionComparator() to return null or an instance of IncomparableComparator.

Returns:

true if the data is versioned; false otherwise.

getVersionComparator

Comparator getVersionComparator()

Get the comparator used to compare two different version values. May return null if isVersioned() returns false.

Returns:

The comparator for versions, or null

getKeyType

Type getKeyType()

Returns:

Type of the key that will be used as the key in the cache, or null if the natural comparison (Object.hashCode() and Object.equals(Object) methods should be used.