org.jadice.util.mm.ckc.events

Class CompositeKeyCacheEntryEvent

java.lang.Object

java.util.EventObject

org.jadice.util.mm.ckc.events.CacheEntryEvent

org.jadice.util.mm.ckc.events.CompositeKeyCacheEntryEvent

All Implemented Interfaces:

Serializable, OwnerKeyComposition

public class CompositeKeyCacheEntryEvent
extends CacheEntryEvent

This is a event fired by the cache. If it references an entry event it contains all the necessary information of the entry.

If it's a general event, such as a cache CLEARED event it will just contain the timestamp as it was fired/created.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
CompositeKeyCacheEntryEvent(Cache source, EventType eventType) Creates an cache event that indicates the cache was cleared, implying that it contains no entries any longer.
CompositeKeyCacheEntryEvent(Cache source, EventType eventType, Object owner, Object key, Object value, int sizeEstimate, long lruTimeStamp, long creationTimestamp) Creates an cache event that references an entry.
CompositeKeyCacheEntryEvent(Cache source, EventType eventType, Object owner, Object key, Object newValue, Object oldValue, int sizeEstimate, long lruTimeStamp, long creationTimestamp) Creates a cache event that references the new entry and hold the value of the old entry.

Method Summary

Modifier and Type	Method and Description
long	getAge()
long	getCreationTimestamp()
Object	getKey() Get the key of the composition, that's owned by the owner.
long	getLastRecentUse()
Object	getOldValue() Returns old value that existed before the the modification that fired the event.
Object	getOwner() Get the owner of the composition, owning the corresponding key.
int	getSizeEstimate()
Object	getValue()
boolean	isOldValueAvailable() Checks whether an old value is available.

Methods inherited from class org.jadice.util.mm.ckc.events.CacheEntryEvent

getEventType, getSource

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeKeyCacheEntryEvent

public CompositeKeyCacheEntryEvent(Cache source,
                                   EventType eventType,
                                   Object owner,
                                   Object key,
                                   Object value,
                                   int sizeEstimate,
                                   long lruTimeStamp,
                                   long creationTimestamp)

Creates an cache event that references an entry.

It will contain the source of the event and the type. Moreover it will hold all of the necessary Information of the entry, such as its owner/key/value, estimated size, last recently used timestamp and the timestamp of the entries creation.

Parameters:

source - The Cache which fired the event.

eventType - The EventType that occurred.

owner - The holding owner or null if there is no owner.

key - The key of the entry.

value - The value of the entry.

sizeEstimate - The estimated size of the entry in bytes.

lruTimeStamp - The timestamp as the entry was last used.

creationTimestamp - The timestamp as the entry was created.

CompositeKeyCacheEntryEvent

public CompositeKeyCacheEntryEvent(Cache source,
                                   EventType eventType,
                                   Object owner,
                                   Object key,
                                   Object newValue,
                                   Object oldValue,
                                   int sizeEstimate,
                                   long lruTimeStamp,
                                   long creationTimestamp)

Creates a cache event that references the new entry and hold the value of the old entry.

It will contain the source of the event and the type. Moreover it will hold all of the necessary information of the entry, such as its owner/key/value, estimated size, last recently used timestamp and the timestamp of the entries creation. In addition it holds also the old entry.

Parameters:

source - The Cache which fired the event.

eventType - The EventType that occurred.

owner - The holding owner or null if there is no owner.

key - The key of the entry.

newValue - The new value of the entry.

oldValue - The old value of the entry.

sizeEstimate - The estimated size of the entry in bytes.

lruTimeStamp - The timestamp as the entry was last used.

creationTimestamp - The timestamp as the entry was created.

CompositeKeyCacheEntryEvent

public CompositeKeyCacheEntryEvent(Cache source,
                                   EventType eventType)

Creates an cache event that indicates the cache was cleared, implying that it contains no entries any longer.

An timestamp of its occurrence is being added.

Parameters:

source - The Cache which fired the event.

eventType - The EventType that occurred. It must be an EventType.CLEARED in this special case!

Method Detail

getOwner

public Object getOwner()

Description copied from interface: OwnerKeyComposition

Get the owner of the composition, owning the corresponding key.

Returns:

The owner

getKey

public Object getKey()

Description copied from interface: OwnerKeyComposition

Get the key of the composition, that's owned by the owner.

Returns:

The key

getValue

public Object getValue()

getOldValue

public Object getOldValue()

Description copied from class: CacheEntryEvent

Returns old value that existed before the the modification that fired the event.

Specified by:

getOldValue in class CacheEntryEvent

Returns:

the previous value or null if there was no previous value

isOldValueAvailable

public boolean isOldValueAvailable()

Description copied from class: CacheEntryEvent

Checks whether an old value is available.

Specified by:

isOldValueAvailable in class CacheEntryEvent

Returns:

true if there is an old value

getSizeEstimate

public int getSizeEstimate()

Returns:

The estimated size of the entry in bytes.

getAge

public long getAge()

Returns:

The Age of the entry at the moment the cache event was fired.

getCreationTimestamp

public long getCreationTimestamp()

Returns:

A timestamp for the entries creation.

getLastRecentUse

public long getLastRecentUse()

Returns:

A timestamp for the last recent use.