oracle.toplink.essentials.internal.identitymaps

Class WeakCacheKey

java.lang.Object

oracle.toplink.essentials.internal.identitymaps.CacheKey

oracle.toplink.essentials.internal.identitymaps.WeakCacheKey

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

HardCacheWeakIdentityMap.ReferenceCacheKey

public class WeakCacheKey
extends CacheKey

Purpose: Container class for storing objects in an IdentityMap. The weak cache key uses a weak reference to allow garbage collection of its object. The cache key itself however will remain and thus should cleaned up every no and then.

Responsibilities:

• Hold key and object.
• Maintain and update the current writeLockValue.

Since:

TOPLink/Java 1.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.ref.WeakReference	reference Reference is maintained weak to allow garbage collection

Fields inherited from class oracle.toplink.essentials.internal.identitymaps.CacheKey

CACHE_KEY_INVALID, CHECK_INVALIDATION_POLICY, hash, invalidationState, key, lastUpdatedQueryId, mapOwner, mutex, object, readTime, record, wrapper, writeLockValue

Constructor Summary

Constructors

Constructor and Description
WeakCacheKey(java.util.Vector primaryKey, java.lang.Object object, java.lang.Object writeLockValue, long readTime) Initialize the newly allocated instance of this class.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getObject()
java.lang.ref.WeakReference	getReference()
void	setObject(java.lang.Object object)
protected void	setReference(java.lang.ref.WeakReference reference)

Methods inherited from class oracle.toplink.essentials.internal.identitymaps.CacheKey

acquire, acquire, acquireDeferredLock, acquireNoWait, acquireNoWait, acquireReadLock, acquireReadLockNoWait, checkReadLock, clone, computeHash, equals, equals, getInvalidationState, getKey, getLastUpdatedQueryId, getMutex, getOwningMap, getReadTime, getRecord, getWrapper, getWriteLockValue, hashCode, isAcquired, release, releaseDeferredLock, releaseReadLock, setInvalidationState, setKey, setLastUpdatedQueryId, setMutex, setOwningMap, setReadTime, setRecord, setWrapper, setWriteLockValue, toString, updateAccess

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

reference

protected java.lang.ref.WeakReference reference

Reference is maintained weak to allow garbage collection

Constructor Detail

WeakCacheKey

public WeakCacheKey(java.util.Vector primaryKey,
                    java.lang.Object object,
                    java.lang.Object writeLockValue,
                    long readTime)

Initialize the newly allocated instance of this class.

Parameters:

primaryKey - contains values extracted from the object

writeLockValue - is the write lock value, null if optimistic locking not being used for this object.

readTime - the time TopLInk read the cache key

Method Detail

getObject

public java.lang.Object getObject()

Overrides:

getObject in class CacheKey

getReference

public java.lang.ref.WeakReference getReference()

setObject

public void setObject(java.lang.Object object)

Overrides:

setObject in class CacheKey

setReference

protected void setReference(java.lang.ref.WeakReference reference)