org.hibernate.cache.internal

Class CacheDataDescriptionImpl

java.lang.Object

org.hibernate.cache.internal.CacheDataDescriptionImpl

All Implemented Interfaces:

CacheDataDescription

public class CacheDataDescriptionImpl
extends java.lang.Object
implements CacheDataDescription

Standard CacheDataDescription implementation.

Constructor Summary

Constructors

Constructor and Description
CacheDataDescriptionImpl(boolean mutable, boolean versioned, java.util.Comparator versionComparator, Type keyType) Constructs a CacheDataDescriptionImpl instance.

Method Summary

Modifier and Type	Method and Description
static CacheDataDescriptionImpl	decode(Collection model) Builds a CacheDataDescriptionImpl from the mapping model of a collection
static CacheDataDescriptionImpl	decode(PersistentClass model) Builds a CacheDataDescriptionImpl from the mapping model of an entity class.
Type	getKeyType()
java.util.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 CacheDataDescription.getVersionComparator() to return null or an instance of IncomparableComparator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CacheDataDescriptionImpl

public CacheDataDescriptionImpl(boolean mutable,
                                boolean versioned,
                                java.util.Comparator versionComparator,
                                Type keyType)

Constructs a CacheDataDescriptionImpl instance. Generally speaking, code should use one of the overloaded decode(org.hibernate.mapping.PersistentClass) methods rather than direct instantiation.

Parameters:

mutable - Is the described data mutable?

versioned - Is the described data versioned?

versionComparator - The described data's version value comparator (if versioned).

keyType -

Method Detail

isMutable

public boolean isMutable()

Description copied from interface: CacheDataDescription

Is the data marked as being mutable?

Specified by:

isMutable in interface CacheDataDescription

Returns:

true if the data is mutable; false otherwise.

isVersioned

public boolean isVersioned()

Description copied from interface: CacheDataDescription

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

Specified by:

isVersioned in interface CacheDataDescription

Returns:

true if the data is versioned; false otherwise.

getVersionComparator

public java.util.Comparator getVersionComparator()

Description copied from interface: CacheDataDescription

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

Specified by:

getVersionComparator in interface CacheDataDescription

Returns:

The comparator for versions, or null

getKeyType

public Type getKeyType()

Specified by:

getKeyType in interface CacheDataDescription

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.

decode

public static CacheDataDescriptionImpl decode(PersistentClass model)

Builds a CacheDataDescriptionImpl from the mapping model of an entity class.

Parameters:

model - The mapping model.

Returns:

The constructed CacheDataDescriptionImpl

decode

public static CacheDataDescriptionImpl decode(Collection model)

Builds a CacheDataDescriptionImpl from the mapping model of a collection

Parameters:

model - The mapping model.

Returns:

The constructed CacheDataDescriptionImpl