info.bioinfweb.commons.collections.observable

Class ListMultipleChangesEvent<E>

java.lang.Object

java.util.EventObject

info.bioinfweb.commons.collections.observable.ListChangeEvent<E>

info.bioinfweb.commons.collections.observable.ListMultipleChangesEvent<E>

Type Parameters:

E - the type of elements in the list where the change occurred

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ListAddEvent

public class ListMultipleChangesEvent<E>
extends ListChangeEvent<E>

An event object indicating that multiple modifications of an instance of List have happened.

Since:

1.1.0

Author:

Ben Stöver

See Also:

ListChangeListener, ObservableList, Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ListMultipleChangesEvent(java.util.List<E> source, ListChangeType type, int index, java.util.Collection<? extends E> affectedElements) Creates a new event object.
ListMultipleChangesEvent(java.util.List<E> source, ListChangeType type, int index, E affectedElement) Creates a new event object.

Method Summary

Modifier and Type	Method and Description
E	getAffectedElement() Returns the first affected element.
java.util.Collection<? extends E>	getAffectedElements() Returns a collection of all elements that will be or have been affected by the list modification (e.g.

Methods inherited from class info.bioinfweb.commons.collections.observable.ListChangeEvent

getIndex, getSource, getType

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ListMultipleChangesEvent

public ListMultipleChangesEvent(java.util.List<E> source,
                                ListChangeType type,
                                int index,
                                java.util.Collection<? extends E> affectedElements)

Creates a new event object.

Parameters:

source - the list instance that has been modified

type - the type of modification that happened

index - the index the first affected element has in the list

affectedElements - a list of elements that have been affected (e.g. inserted or removed)

ListMultipleChangesEvent

public ListMultipleChangesEvent(java.util.List<E> source,
                                ListChangeType type,
                                int index,
                                E affectedElement)

Creates a new event object. Use this constructor if only one element is affected.

Parameters:

source - the list instance that has been modified

type - the type of modification that happened

index - the index the first affected element has in the list

affectedElement - a list of elements that have been affected (e.g. inserted, removed)

Method Detail

getAffectedElements

public java.util.Collection<? extends E> getAffectedElements()

Returns a collection of all elements that will be or have been affected by the list modification (e.g. all elements that have been add).

Returns:

a collection of the affected list elements

getAffectedElement

public E getAffectedElement()

Returns the first affected element. Convenience method if only one element is affected.

Returns:

the fist affected element in getAffectedElements()