org.eclipse.jpt.common.utility.model.event
Class ListRemoveEvent

java.lang.Object
  java.util.EventObject
      org.eclipse.jpt.common.utility.model.event.ChangeEvent
          org.eclipse.jpt.common.utility.model.event.ListEvent
              org.eclipse.jpt.common.utility.model.event.ListRemoveEvent

All Implemented Interfaces:

java.io.Serializable

public final class ListRemoveEvent
extends ListEvent

A "list remove" event gets delivered whenever a model removes items from a "bound" or "constrained" list. A ListRemoveEvent is sent as an argument to the ListChangeListener.

Provisional API: This class is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

See Also:

Serialized Form

Constructor Summary

ListRemoveEvent(Model source, java.lang.String listName, int index, java.util.Collection<?> items)
Construct a new list remove event.

ListRemoveEvent(Model source, java.lang.String listName, int index, java.lang.Object item)
Construct a new list remove event.

Method Summary

ListRemoveEvent	clone(Model newSource) Return a copy of the event with the specified source replacing the current source.
ListRemoveEvent	clone(Model newSource, java.lang.String newListName) Return a copy of the event with the specified source and list name replacing the current source and list name.
ListRemoveEvent	clone(Model newSource, java.lang.String newListName, int offset) Return a copy of the event with the specified source and list name replacing the current source and list name and displacing the index by the specified amount.
int	getIndex() Return the index at which the items were removed from the list.
java.lang.Iterable<?>	getItems() Return the items removed from the list.
int	getItemsSize() Return the number of items removed from the list.

Methods inherited from class org.eclipse.jpt.common.utility.model.event.ListEvent

getListName

Methods inherited from class org.eclipse.jpt.common.utility.model.event.ChangeEvent

getSource, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ListRemoveEvent

public ListRemoveEvent(Model source,
                       java.lang.String listName,
                       int index,
                       java.lang.Object item)

Construct a new list remove event.

Parameters:

source - The object on which the event initially occurred.

collectionName - The programmatic name of the list that was changed.

index - The index at which the items were removed.

item - The item removed from the list.

ListRemoveEvent

public ListRemoveEvent(Model source,
                       java.lang.String listName,
                       int index,
                       java.util.Collection<?> items)

Construct a new list remove event.

Parameters:

source - The object on which the event initially occurred.

collectionName - The programmatic name of the list that was changed.

index - The index at which the items were removed.

items - The items removed from the list.

Method Detail

getIndex

public int getIndex()

Return the index at which the items were removed from the list.

getItems

public java.lang.Iterable<?> getItems()

Return the items removed from the list.

getItemsSize

public int getItemsSize()

Return the number of items removed from the list.

clone

public ListRemoveEvent clone(Model newSource)

Return a copy of the event with the specified source replacing the current source.

clone

public ListRemoveEvent clone(Model newSource,
                             java.lang.String newListName)

Return a copy of the event with the specified source and list name replacing the current source and list name.

clone

public ListRemoveEvent clone(Model newSource,
                             java.lang.String newListName,
                             int offset)

Return a copy of the event with the specified source and list name replacing the current source and list name and displacing the index by the specified amount.