Package com.vaadin.collaborationengine

Class ListChangeEvent

  • All Implemented Interfaces:
    Serializable
    public class ListChangeEvent
extends EventObject
    Event that is fired when the value in a collaboration list changes.
    Since:
    3.1
    Author:
    Vaadin Ltd
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      <T> Optional<T> getAddedItem​(com.fasterxml.jackson.core.type.TypeReference<T> type)
      Deprecated.
      This method is preserved for backwards compatibility from the initial version when the only possible list change was to add a new item to the end of the list.
      <T> Optional<T> getAddedItem​(Class<T> type)
      Deprecated.
      This method is preserved for backwards compatibility from the initial version when the only possible list change was to add a new item to the end of the list.
      ListKey getAfter()
      Gets the key of the item which is after the current item after the change.
      ListKey getBefore()
      Gets the key of the item which is before the current item after the change.
      ListKey getKey()
      Gets the key of the list item affected by the change.
      ListKey getOldAfter()
      Gets the key of the item which was after the current item before the change.
      ListKey getOldBefore()
      Gets the key of the item which was before the current item before the change.
      <T> T getOldValue​(com.fasterxml.jackson.core.type.TypeReference<T> type)
      Gets the old value of the list item affected by the change as instance corresponding to the given type reference.
      <T> T getOldValue​(Class<T> type)
      Gets the old value of the list item affected by the change as instance of the given class.
      CollaborationList getSource()  
      <T> T getValue​(com.fasterxml.jackson.core.type.TypeReference<T> type)
      Gets the current value of the list item affected by the change as instance corresponding to the given type reference.
      <T> T getValue​(Class<T> type)
      Gets the current value of the list item affected by the change as instance of the given class.

    • Method Detail

      • getKey

        public ListKey getKey()
        Gets the key of the list item affected by the change.
        Returns:
        the key of the changed item, not null

      • getValue

        public <T> T getValue​(Class<T> type)
        Gets the current value of the list item affected by the change as instance of the given class.

        If the item was removed by the change, this method returns null and getOldValue(Class) return the removed item value.

        Type Parameters:
        T - the type of the value from type parameter, e.g. String
        Parameters:
        type - the expected type of the returned instance
        Returns:
        the current value of the item affected by the change

      • getValue

        public <T> T getValue​(com.fasterxml.jackson.core.type.TypeReference<T> type)
        Gets the current value of the list item affected by the change as instance corresponding to the given type reference.

        If the item was removed by the change, this method returns null and getOldValue(TypeReference) return the removed item value.

        Type Parameters:
        T - the type reference of the value from type parameter, e.g. List
        Parameters:
        type - the expected type reference of the returned instance
        Returns:
        the current value of the item affected by the change

      • getOldValue

        public <T> T getOldValue​(Class<T> type)
        Gets the old value of the list item affected by the change as instance of the given class.
        Type Parameters:
        T - the type of the value from type parameter, e.g. String
        Parameters:
        type - the expected type of the returned instance
        Returns:
        the old value of the item affected by the change

      • getOldValue

        public <T> T getOldValue​(com.fasterxml.jackson.core.type.TypeReference<T> type)
        Gets the old value of the list item affected by the change as instance corresponding to the given type reference.
        Type Parameters:
        T - the type reference of the value from type parameter, e.g. List
        Parameters:
        type - the expected type reference of the returned instance
        Returns:
        the old value of the item affected by the change

      • getAfter

        public ListKey getAfter()
        Gets the key of the item which is after the current item after the change.
        Returns:
        the key of the item which is after the current item, or null if there is none

      • getOldAfter

        public ListKey getOldAfter()
        Gets the key of the item which was after the current item before the change.
        Returns:
        the key of the item which was after the current item, or null if there was none

      • getBefore

        public ListKey getBefore()
        Gets the key of the item which is before the current item after the change.
        Returns:
        the key of the item which is before the current item, or null if there is none

      • getOldBefore

        public ListKey getOldBefore()
        Gets the key of the item which was before the current item before the change.
        Returns:
        the key of the item which was before the current item, or null if there was none

      • getAddedItem

        @Deprecated
public <T> Optional<T> getAddedItem​(Class<T> type)
        Deprecated.
        This method is preserved for backwards compatibility from the initial version when the only possible list change was to add a new item to the end of the list.
        Gets the added item as instance of the given class.
        Type Parameters:
        T - the type of the class given as the type argument
        Parameters:
        type - the class of the expected type of the returned instance
        Returns:
        the added item, or an empty optional if no item was added

      • getAddedItem

        @Deprecated
public <T> Optional<T> getAddedItem​(com.fasterxml.jackson.core.type.TypeReference<T> type)
        Deprecated.
        This method is preserved for backwards compatibility from the initial version when the only possible list change was to add a new item to the end of the list.
        Gets the added item as instance of the given type reference.
        Type Parameters:
        T - the type of the reference given as the type argument
        Parameters:
        type - the expected type reference of the returned instance
        Returns:
        the added item, or an empty optional if no item was added