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

java.lang.Object
  java.util.EventObject
      org.eclipse.jpt.common.utility.model.event.ChangeEvent
          org.eclipse.jpt.common.utility.model.event.CollectionEvent
              org.eclipse.jpt.common.utility.model.event.CollectionRemoveEvent

All Implemented Interfaces:

java.io.Serializable

public final class CollectionRemoveEvent
extends CollectionEvent

A "collection remove" event gets delivered whenever a model removes items from a "bound" or "constrained" collection. A CollectionRemoveEvent is sent as an argument to the CollectionChangeListener.

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

CollectionRemoveEvent(Model source, java.lang.String collectionName, java.util.Collection<?> items)
Construct a new collection remove event.

CollectionRemoveEvent(Model source, java.lang.String collectionName, java.lang.Object item)
Construct a new collection remove event.

Method Summary

CollectionRemoveEvent	clone(Model newSource) Return a copy of the event with the specified source replacing the current source.
CollectionRemoveEvent	clone(Model newSource, java.lang.String newCollectionName) Return a copy of the event with the specified source and collection name replacing the current source and collection name.
java.lang.Iterable<?>	getItems() Return the items removed from the collection.
int	getItemsSize() Return the number of items removed from the collection.

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

getCollectionName

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

CollectionRemoveEvent

public CollectionRemoveEvent(Model source,
                             java.lang.String collectionName,
                             java.lang.Object item)

Construct a new collection remove event.

Parameters:

source - The object on which the event initially occurred.

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

item - The item removed from the collection.

CollectionRemoveEvent

public CollectionRemoveEvent(Model source,
                             java.lang.String collectionName,
                             java.util.Collection<?> items)

Construct a new collection remove event.

Parameters:

source - The object on which the event initially occurred.

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

items - The items removed from the collection.

Method Detail

getItems

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

Return the items removed from the collection.

getItemsSize

public int getItemsSize()

Return the number of items removed from the collection.

clone

public CollectionRemoveEvent clone(Model newSource)

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

clone

public CollectionRemoveEvent clone(Model newSource,
                                   java.lang.String newCollectionName)

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