|
EclipseLink 1.0_1.0M2 API Reference - Incubation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.persistence.descriptors.invalidation.CacheInvalidationPolicy
public abstract class CacheInvalidationPolicy
PUBLIC: A CacheInvalidationPolicy is used to set objects in TopLink's identity maps to be invalid following given rules. CacheInvalidationPolicy is the abstract superclass for all policies used for cache invalidation. By default in TopLink, objects do not expire in the cache. Several different policies are available to allow objects to expire. These can be set on the ClassDescriptor.
ClassDescriptor
,
org.eclipse.persistence.descriptors.cacheinvalidation.NoExpiryCacheInvalidationPolicy
,
org.eclipse.persistence.descriptors.cacheinvalidation.DailyCacheInvalidationPolicy
,
org.eclipse.persistence.descriptors.cacheinvalidation.TimeToLiveCacheInvalidationPolicy
,
Serialized FormField Summary | |
---|---|
static long |
NO_EXPIRY
|
protected boolean |
shouldUpdateReadTimeOnUpdate
this will represent objects that do not expire |
Constructor Summary | |
---|---|
CacheInvalidationPolicy()
|
Method Summary | |
---|---|
abstract long |
getExpiryTimeInMillis(CacheKey key)
INTERNAL: Get the next time when this object will become invalid |
long |
getRemainingValidTime(CacheKey key)
INTERNAL: Return the remaining life of this object |
boolean |
isInvalidated(CacheKey key)
INTERNAL: return true if this object is expire, false otherwise. |
abstract boolean |
isInvalidated(CacheKey key,
long currentTimeMillis)
INTERNAL: return true if this object is expire, false otherwise. |
void |
setShouldUpdateReadTimeOnUpdate(boolean shouldUpdateReadTime)
PUBLIC: Set whether to update the stored time an object was read when an object is updated. |
boolean |
shouldUpdateReadTimeOnUpdate()
PUBLIC: Return whether objects affected by this CacheInvalidationPolicy should have the read time on their cache keys updated when an update occurs. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final long NO_EXPIRY
protected boolean shouldUpdateReadTimeOnUpdate
Constructor Detail |
---|
public CacheInvalidationPolicy()
Method Detail |
---|
public abstract long getExpiryTimeInMillis(CacheKey key)
public long getRemainingValidTime(CacheKey key)
public boolean isInvalidated(CacheKey key)
public abstract boolean isInvalidated(CacheKey key, long currentTimeMillis)
public void setShouldUpdateReadTimeOnUpdate(boolean shouldUpdateReadTime)
public boolean shouldUpdateReadTimeOnUpdate()
|
EclipseLink 1.0_1.0M2 API Reference - Incubation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |