Package io.guise.framework.event

Class CollectionEvent<E>

  • Type Parameters:
    E - The type of elements contained in the collection.
    All Implemented Interfaces:
    com.globalmentor.event.Event, GuiseEvent, java.io.Serializable
    Direct Known Subclasses:
    ListEvent, SetEvent
    public class CollectionEvent<E>
extends AbstractGuiseEvent
    An event indicating a collection has been modified. If a single element was replaced both an added and removed element will be provided. If neither an added nor a removed element are provided, the event represents a general collection modification.
    Author:
    Garret Wilson
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from class java.util.EventObject

        source

    • Constructor Summary

      Constructors 
      Constructor Description
      CollectionEvent​(java.lang.Object source)
      Source constructor for general collection modification.
      CollectionEvent​(java.lang.Object source, E addedElement, E removedElement)
      Source constructor for an added and/or removed element.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      E getAddedElement()  
      E getRemovedElement()  

      • Methods inherited from class java.util.EventObject

        getSource, toString

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface com.globalmentor.event.Event

        getSource

    • Constructor Detail

      • CollectionEvent

        public CollectionEvent​(java.lang.Object source)
        Source constructor for general collection modification.
        Parameters:
        source - The object on which the event initially occurred.
        Throws:
        java.lang.NullPointerException - if the given source is null.

      • CollectionEvent

        public CollectionEvent​(java.lang.Object source,
                       E addedElement,
                       E removedElement)
        Source constructor for an added and/or removed element.
        Parameters:
        source - The object on which the event initially occurred.
        addedElement - The element that was added to the collection, or null if no element was added or it is unknown whether or which elements were added.
        removedElement - The element that was removed from the collection, or null if no element was removed or it is unknown whether or which elements were removed.
        Throws:
        java.lang.NullPointerException - if the given source is null.

    • Method Detail

      • getAddedElement

        public E getAddedElement()
        Returns:
        The element that was added to the collection, or null if no element was added or it is unknown whether or which elements were added.

      • getRemovedElement

        public E getRemovedElement()
        Returns:
        The element that was removed from the collection, or null if no element was added or it is unknown whether or which elements were removed.