org.eclipse.jpt.utility.model.event
Class CollectionAddEvent

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

All Implemented Interfaces:

java.io.Serializable

public final class CollectionAddEvent
extends CollectionEvent

A "collection add" event gets delivered whenever a model adds items to a "bound" or "constrained" collection. A CollectionAddEvent 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

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

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

Method Summary

CollectionAddEvent	clone(Model newSource) Return a copy of the event with the specified source replacing the current source.
CollectionAddEvent	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 added to the collection.
int	getItemsSize() Return the number of items added to the collection.

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

getCollectionName

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

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionAddEvent

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

Construct a new collection add event.

Parameters:

source - The object on which the event initially occurred.

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

item - The item added to the collection.

CollectionAddEvent

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

Construct a new collection add event.

Parameters:

source - The object on which the event initially occurred.

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

items - The items added to the collection.

Method Detail

getItems

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

Return the items added to the collection.

getItemsSize

public int getItemsSize()

Return the number of items added to the collection.

clone

public CollectionAddEvent clone(Model newSource)

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

clone

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