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

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.ListReplaceEvent

All Implemented Interfaces:

java.io.Serializable

public final class ListReplaceEvent
extends ListEvent

A "list replace" event gets delivered whenever a model replaces items in a "bound" or "constrained" list. A ListReplaceEvent 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

ListReplaceEvent(Model source, java.lang.String listName, int index, java.util.List<?> newItems, java.util.List<?> oldItems)
Construct a new list replace event for a list of replaced items.

ListReplaceEvent(Model source, java.lang.String listName, int index, java.lang.Object newItem, java.lang.Object oldItem)
Construct a new list replace event for a list of replaced items.

Method Summary

ListReplaceEvent	clone(Model newSource) Return a copy of the event with the specified source replacing the current source.
ListReplaceEvent	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.
ListReplaceEvent	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 replaced in the list.
int	getItemsSize() Return the number of items that were replaced.
java.lang.Iterable<?>	getNewItems() Return the new items that replaced the old items in the list.
java.lang.Iterable<?>	getOldItems() Return the old items that were replaced by the new items in 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

ListReplaceEvent

public ListReplaceEvent(Model source,
                        java.lang.String listName,
                        int index,
                        java.lang.Object newItem,
                        java.lang.Object oldItem)

Construct a new list replace event for a list of replaced items.

Parameters:

source - The object on which the event initially occurred.

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

index - The index at which the item in the list was replaced.

newItem - The new item in the list.

oldItem - The old item in the list that were replaced.

ListReplaceEvent

public ListReplaceEvent(Model source,
                        java.lang.String listName,
                        int index,
                        java.util.List<?> newItems,
                        java.util.List<?> oldItems)

Construct a new list replace event for a list of replaced items.

Parameters:

source - The object on which the event initially occurred.

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

index - The index at which the items in the list were replaced.

newItems - The new items in the list.

oldItems - The old items in the list that were replaced.

Method Detail

getIndex

public int getIndex()

Return the index at which the items were replaced in the list.

getNewItems

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

Return the new items that replaced the old items in the list.

getOldItems

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

Return the old items that were replaced by the new items in the list.

getItemsSize

public int getItemsSize()

Return the number of items that were replaced.

clone

public ListReplaceEvent clone(Model newSource)

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

clone

public ListReplaceEvent 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 ListReplaceEvent 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.