Module org.eclipse.persistence.jpa.jpql
Package org.eclipse.persistence.jpa.jpql.tools.model

Interface IListChangeEvent<T>

All Known Implementing Classes:
ListChangeEvent
public interface IListChangeEvent<T>
This is used in conjunction with IListChangeListener. It contains the information regarding the content of a list being changed.
Since:
2.4
Version:
2.5

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    IListChangeEvent.EventType
    This enumeration lists the possible modification a list can have.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getEndIndex()
    Returns the index of where the change occurred in the list.
    IListChangeEvent.EventType
    getEventType()
    Returns the type of change that occurred in the list.
    List<T>
    getList()
    Returns a copy of the actual list after the change has happened.
    String
    getListName()
    Returns the name describing the list.
    <S extends ListHolderStateObject<? extends T>>
    S
    getSource()
    Returns the source where the modification occurred and that fired the event.
    int
    getStartIndex()
    Returns the index of where the change occurred in the list.
    ListIterable<T>
    items()
    Returns the list of items that have caused the original list to change.
    int
    itemsSize()
    Returns the number of items that caused the original list to change.

  • Method Details

    • getEndIndex

      int getEndIndex()
      Returns the index of where the change occurred in the list.
      Returns:
      The index of where the change occurred in the list

    • getEventType

      IListChangeEvent.EventType getEventType()
      Returns the type of change that occurred in the list.
      Returns:
      One of the possible types of changes

    • getList

      List<T> getList()
      Returns a copy of the actual list after the change has happened.
      Returns:
      The copy of the list that got changed

    • getListName

      String getListName()
      Returns the name describing the list.
      Returns:
      The name of the list for which IListChangeListeners have been registered with the source to be notified upon changes

    • getSource

      <S extends ListHolderStateObject<? extends T>> S getSource()
      Returns the source where the modification occurred and that fired the event.
      Type Parameters:
      S - The type of the source owning the list
      Returns:
      The source of the event

    • getStartIndex

      int getStartIndex()
      Returns the index of where the change occurred in the list.
      Returns:
      The index of where the change occurred in the list

    • items

      ListIterable<T> items()
      Returns the list of items that have caused the original list to change. Depending on the even type:
      Returns:
      The list of items associated with the IListChangeEvent.EventType

    • itemsSize

      int itemsSize()
      Returns the number of items that caused the original list to change.
      Returns:
      The count of items triggering this event