Package com.vaadin.collaborationengine

Class ListChangeEvent

java.lang.Object
java.util.EventObject
com.vaadin.collaborationengine.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:

  • Field Summary

    Fields inherited from class java.util.EventObject

    source

  • Method Summary

    Modifier and Type
    Method
    Description
    ListKey
    getKey()
    Gets the key of the list item affected by the change.
    ListKey
    getNext()
    Gets the key of the item which is after the current item after the change.
    ListKey
    getOldNext()
    Gets the key of the item which was after the current item before the change.
    ListKey
    getOldPrev()
    Gets the key of the item which was before the current item before the change.
    <T> T
    getOldValue(Class<T> type)
    Gets the old value of the list item affected by the change as instance of the given class.
    <T> T
    getOldValue(tools.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.
    ListKey
    getPrev()
    Gets the key of the item which is before the current item after the change.
    CollaborationList
    getSource()
     
    <T> T
    getValue(Class<T> type)
    Gets the current value of the list item affected by the change as instance of the given class.
    <T> T
    getValue(tools.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.

    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

  • Method Details

    • getSource

      public CollaborationList getSource()
      Overrides:
      getSource in class EventObject

    • 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(tools.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(tools.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

    • getNext

      public ListKey getNext()
      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

    • getOldNext

      public ListKey getOldNext()
      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

    • getPrev

      public ListKey getPrev()
      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

    • getOldPrev

      public ListKey getOldPrev()
      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