Interface CacheEntryModifiedEvent<K,​V>

  • All Superinterfaces:
    CacheEntryEvent<K,​V>, Event<K,​V>, TransactionalEvent<K,​V>
    All Known Implementing Classes:
    ClusterEvent, EventImpl

    public interface CacheEntryModifiedEvent<K,​V>
    extends CacheEntryEvent<K,​V>
    This event subtype is passed in to any method annotated with CacheEntryModified

    The getValue() method's behavior is specific to whether the callback is triggered before or after the event in question. For example, if event.isPre() is true, then event.getValue() would return the old value, prior to modification. If event.isPre() is false, then event.getValue() would return new new value. If the event is creating and inserting a new entry, the old value would be null.

    Since:
    4.0
    Author:
    Manik Surtani
    • Method Detail

      • getOldValue

        V getOldValue()
        Retrieves the old value of the entry being modified.

        Returns:
        the previous value of the entry, regardless of whether isPre() is true or false.
      • getNewValue

        V getNewValue()
        Retrieves the new value of the entry being modified.

        Returns:
        the new value of the entry, regardless of whether isPre() is true or false.
      • getOldMetadata

        Metadata getOldMetadata()
        Regardless of whether isPre() is true or is false, this method returns the metadata 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.
        Returns:
        the metadata of the entry being deleted, regardless of isPre() value
      • isCreated

        boolean isCreated()
        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.
        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
      • isCommandRetried

        boolean isCommandRetried()
        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)
        Returns:
        Whether the command that caused this event was retried