EventImpl (Infinispan 8.2.4.Final API)

java.lang.Object
- org.infinispan.notifications.cachelistener.event.impl.EventImpl<K,V>

All Implemented Interfaces:

Cloneable, CacheEntriesEvictedEvent, CacheEntryActivatedEvent, CacheEntryCreatedEvent, CacheEntryEvent, CacheEntryExpiredEvent, CacheEntryInvalidatedEvent, CacheEntryLoadedEvent, CacheEntryModifiedEvent, CacheEntryPassivatedEvent, CacheEntryRemovedEvent, CacheEntryVisitedEvent, DataRehashedEvent, Event, PartitionStatusChangedEvent, TopologyChangedEvent, TransactionalEvent, TransactionCompletedEvent, TransactionRegisteredEvent
```
@NotThreadSafe
public class EventImpl<K,V>
extends Object
implements CacheEntryActivatedEvent, CacheEntryCreatedEvent, CacheEntriesEvictedEvent, CacheEntryLoadedEvent, CacheEntryModifiedEvent, CacheEntryPassivatedEvent, CacheEntryRemovedEvent, CacheEntryVisitedEvent, TransactionCompletedEvent, TransactionRegisteredEvent, CacheEntryInvalidatedEvent, DataRehashedEvent, TopologyChangedEvent, CacheEntryExpiredEvent, PartitionStatusChangedEvent, Cloneable
```
Basic implementation of an event that covers all event types.

Since:

4.0

Author:

Manik Surtani

Constructor Summary

Constructors
Constructor and Description

EventImpl()

Constructors
Constructor and Description
`EventImpl()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EventImpl<K,V>`	`clone()`
`static <K,V> EventImpl<K,V>`	`createEvent(Cache<K,V> cache, Event.Type type)`
`boolean`	`equals(Object o)`
`AvailabilityMode`	`getAvailabilityMode()` The mode the current cluster is in.
`Cache<K,V>`	`getCache()`
`ConsistentHash`	`getConsistentHashAtEnd()`
`ConsistentHash`	`getConsistentHashAtStart()`
`Map<? extends K,? extends V>`	`getEntries()` Retrieves entries being evicted.
`GlobalTransaction`	`getGlobalTransaction()`
`K`	`getKey()`
`Collection<Address>`	`getMembersAtEnd()`
`Collection<Address>`	`getMembersAtStart()`
`Metadata`	`getMetadata()` Retrieves the metadata associated with the entry.
`int`	`getNewTopologyId()`
`Metadata`	`getOldMetadata()`
`V`	`getOldValue()` Regardless of whether `isPre()` is `true` or is `false`, this method returns the value of the entry being deleted.
`Event.Type`	`getType()`
`ConsistentHash`	`getUnionConsistentHash()`
`V`	`getValue()` Retrieves the value of the entry being activated.
`int`	`hashCode()`
`boolean`	`isCommandRetried()` This will be true if the write command that caused this had to be retried again due to a topology change.
`boolean`	`isCreated()` Indicates whether the cache entry modification event is the result of the cache entry being created.
`boolean`	`isOriginLocal()`
`boolean`	`isPre()`
`boolean`	`isTransactionSuccessful()`
`void`	`setAvailabilityMode(AvailabilityMode mode)`
`void`	`setCommandRetried(boolean commandRetried)`
`void`	`setConsistentHashAtEnd(ConsistentHash consistentHashAtEnd)`
`void`	`setConsistentHashAtStart(ConsistentHash consistentHashAtStart)`
`void`	`setCreated(boolean created)`
`void`	`setEntries(Map<? extends K,? extends V> entries)`
`void`	`setKey(K key)`
`void`	`setMetadata(Metadata metadata)`
`void`	`setNewTopologyId(int newTopologyId)`
`void`	`setOldMetadata(Metadata metadata)`
`void`	`setOldValue(V oldValue)`
`void`	`setOriginLocal(boolean originLocal)`
`void`	`setPre(boolean pre)`
`void`	`setTransactionId(GlobalTransaction transaction)`
`void`	`setTransactionSuccessful(boolean transactionSuccessful)`
`void`	`setUnionConsistentHash(ConsistentHash unionConsistentHash)`
`void`	`setValue(V value)`
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EventImpl
```
public EventImpl()
```
- Method Detail
  - createEvent
```
public static <K,V> EventImpl<K,V> createEvent(Cache<K,V> cache,
                                               Event.Type type)
```
  - getType
```
public Event.Type getType()
```
    Specified by:
    
    getType in interface Event
    
    Returns:
    
    the type of event represented by this instance.
  - isPre
```
public boolean isPre()
```
    Specified by:
    
    isPre in interface Event
    
    Returns:
    
    true if the notification is before the event has occurred, false if after the event has occurred.
  - getCache
```
public Cache<K,V> getCache()
```
    Specified by:
    
    getCache in interface Event
    
    Returns:
    
    a handle to the cache instance that generated this notification.
  - getKey
```
public K getKey()
```
    Specified by:
    
    getKey in interface CacheEntryEvent
    
    Returns:
    
    the key to the affected cache entry.
  - getGlobalTransaction
```
public GlobalTransaction getGlobalTransaction()
```
    Specified by:
    
    getGlobalTransaction in interface TransactionalEvent
    
    Returns:
    
    the Transaction associated with the current call. May be null if the current call is outside the scope of a transaction.
  - isOriginLocal
```
public boolean isOriginLocal()
```
    Specified by:
    
    isOriginLocal in interface TransactionalEvent
    
    Returns:
    
    true if the call originated on the local cache instance; false if originated from a remote one.
  - isTransactionSuccessful
```
public boolean isTransactionSuccessful()
```
    Specified by:
    
    isTransactionSuccessful in interface TransactionCompletedEvent
    
    Returns:
    
    if true, the transaction completed by committing successfully. If false, the transaction completed with a rollback.
  - setPre
```
public void setPre(boolean pre)
```
  - setKey
```
public void setKey(K key)
```
  - setTransactionId
```
public void setTransactionId(GlobalTransaction transaction)
```
  - setOriginLocal
```
public void setOriginLocal(boolean originLocal)
```
  - setTransactionSuccessful
```
public void setTransactionSuccessful(boolean transactionSuccessful)
```
  - setConsistentHashAtStart
```
public void setConsistentHashAtStart(ConsistentHash consistentHashAtStart)
```
  - setConsistentHashAtEnd
```
public void setConsistentHashAtEnd(ConsistentHash consistentHashAtEnd)
```
  - setUnionConsistentHash
```
public void setUnionConsistentHash(ConsistentHash unionConsistentHash)
```
  - setNewTopologyId
```
public void setNewTopologyId(int newTopologyId)
```
  - setMetadata
```
public void setMetadata(Metadata metadata)
```
  - getMetadata
```
public Metadata getMetadata()
```
    Description copied from interface: CacheEntryEvent
    
    Retrieves the metadata associated with the entry.
    
    Specified by:
    
    getMetadata in interface CacheEntryEvent
    
    Returns:
    
    the metadata of the cache entry
  - setOldMetadata
```
public void setOldMetadata(Metadata metadata)
```
  - getOldMetadata
```
public Metadata getOldMetadata()
```
  - getValue
```
public V getValue()
```
    Description copied from interface: CacheEntryActivatedEvent
    
    Retrieves the value of the entry being activated.
    
    Specified by:
    
    getValue in interface CacheEntryActivatedEvent
    
    Specified by:
    
    getValue in interface CacheEntryCreatedEvent
    
    Specified by:
    
    getValue in interface CacheEntryEvent
    
    Specified by:
    
    getValue in interface CacheEntryExpiredEvent
    
    Specified by:
    
    getValue in interface CacheEntryInvalidatedEvent
    
    Specified by:
    
    getValue in interface CacheEntryLoadedEvent
    
    Specified by:
    
    getValue in interface CacheEntryModifiedEvent
    
    Specified by:
    
    getValue in interface CacheEntryPassivatedEvent
    
    Specified by:
    
    getValue in interface CacheEntryRemovedEvent
    
    Specified by:
    
    getValue in interface CacheEntryVisitedEvent
    
    Returns:
    
    the value of the activated entry
  - setCommandRetried
```
public void setCommandRetried(boolean commandRetried)
```
  - isCommandRetried
```
public boolean isCommandRetried()
```
    Description copied from interface: CacheEntryCreatedEvent
    
    This will be true if the write command that caused this had to be retried again due to a topology change. This could be a sign that this event has been duplicated or another event was dropped and replaced (eg: ModifiedEvent replaced CreateEvent)
    
    Specified by:
    
    isCommandRetried in interface CacheEntryCreatedEvent
    
    Specified by:
    
    isCommandRetried in interface CacheEntryModifiedEvent
    
    Specified by:
    
    isCommandRetried in interface CacheEntryRemovedEvent
    
    Returns:
    
    Whether the command that caused this event was retried
  - isCreated
```
public boolean isCreated()
```
    Description copied from interface: CacheEntryModifiedEvent
    
    Indicates whether the cache entry modification event is the result of the cache entry being created. This method helps determine if the cache entry was created when event.isPre() is false.
    
    Specified by:
    
    isCreated in interface CacheEntryModifiedEvent
    
    Returns:
    
    true if the event is the result of the entry being created, otherwise it returns false indicating that the event was the result of a cache entry being updated
  - getOldValue
```
public V getOldValue()
```
    Description copied from interface: CacheEntryRemovedEvent
    
    Regardless of whether isPre() is true or is false, this method returns the value of the entry being deleted. This method is useful for situations where cache listeners need to know what the old value being deleted is when getting isPre() is false callbacks.
    
    Specified by:
    
    getOldValue in interface CacheEntryRemovedEvent
    
    Returns:
    
    the value of the entry being deleted, regardless of isPre() value
  - setValue
```
public void setValue(V value)
```
  - setEntries
```
public void setEntries(Map<? extends K,? extends V> entries)
```
  - setCreated
```
public void setCreated(boolean created)
```
  - setOldValue
```
public void setOldValue(V oldValue)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getMembersAtStart
```
public Collection<Address> getMembersAtStart()
```
    Specified by:
    
    getMembersAtStart in interface DataRehashedEvent
    
    Returns:
    
    Retrieves the list of members before rehashing started.
  - getMembersAtEnd
```
public Collection<Address> getMembersAtEnd()
```
    Specified by:
    
    getMembersAtEnd in interface DataRehashedEvent
    
    Returns:
    
    Retrieves the list of members after rehashing ended.
  - getConsistentHashAtStart
```
public ConsistentHash getConsistentHashAtStart()
```
    Specified by:
    
    getConsistentHashAtStart in interface DataRehashedEvent
    
    Specified by:
    
    getConsistentHashAtStart in interface TopologyChangedEvent
    
    Returns:
    
    The current consistent hash that was installed prior to the rehash. It is both for reading and writing before the rehash, and only for reading during the rehash.
  - getConsistentHashAtEnd
```
public ConsistentHash getConsistentHashAtEnd()
```
    Specified by:
    
    getConsistentHashAtEnd in interface DataRehashedEvent
    
    Specified by:
    
    getConsistentHashAtEnd in interface TopologyChangedEvent
    
    Returns:
    
    The consistent hash that will be installed after the rehash. It will be used both for reading and writing once it is installed.
  - getUnionConsistentHash
```
public ConsistentHash getUnionConsistentHash()
```
    Specified by:
    
    getUnionConsistentHash in interface DataRehashedEvent
    
    Returns:
    
    The union of the current and future consistent hashes. It is used for writing during the rehash.
  - getNewTopologyId
```
public int getNewTopologyId()
```
    Specified by:
    
    getNewTopologyId in interface DataRehashedEvent
    
    Specified by:
    
    getNewTopologyId in interface TopologyChangedEvent
    
    Returns:
    
    Retrieves the new topology id after rehashing was triggered.
  - getAvailabilityMode
```
public AvailabilityMode getAvailabilityMode()
```
    Description copied from interface: PartitionStatusChangedEvent
    
    The mode the current cluster is in. This determines which operations can be ran in the cluster.
    
    Specified by:
    
    getAvailabilityMode in interface PartitionStatusChangedEvent
    
    Returns:
    
    the mode
  - setAvailabilityMode
```
public void setAvailabilityMode(AvailabilityMode mode)
```
  - getEntries
```
public Map<? extends K,? extends V> getEntries()
```
    Description copied from interface: CacheEntriesEvictedEvent
    
    Retrieves entries being evicted.
    
    Specified by:
    
    getEntries in interface CacheEntriesEvictedEvent
    
    Returns:
    
    A map containing the key/value pairs of the cache entries being evicted.
  - clone
```
public EventImpl<K,V> clone()
```
    Overrides:
    
    clone in class Object

Class EventImpl<K,V>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EventImpl

Method Detail

createEvent

getType

isPre

getCache

getKey

getGlobalTransaction

isOriginLocal

isTransactionSuccessful

setPre

setKey

setTransactionId

setOriginLocal

setTransactionSuccessful

setConsistentHashAtStart

setConsistentHashAtEnd

setUnionConsistentHash

setNewTopologyId

setMetadata

getMetadata

setOldMetadata

getOldMetadata

getValue

setCommandRetried

isCommandRetried

isCreated

getOldValue

setValue

setEntries

setCreated

setOldValue

equals

hashCode

toString

getMembersAtStart

getMembersAtEnd

getConsistentHashAtStart

getConsistentHashAtEnd

getUnionConsistentHash

getNewTopologyId

getAvailabilityMode

setAvailabilityMode

getEntries

clone