info.bioinfweb.commons.collections.observable

Class ListRemoveEvent<L,E>

java.lang.Object

java.util.EventObject

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

info.bioinfweb.commons.collections.observable.ListRemoveEvent<L,E>

Type Parameters:

L - the type of elements in the list to be modified

E - the type of elements will be or have been removed (Note that these types can only be different if this event is fired before the removal, because elements which are not in the associated list might anyway be requested to be removed in that case.)

All Implemented Interfaces:

java.io.Serializable

public class ListRemoveEvent<L,E>
extends ListChangeEvent<L>

Event that indicates that one or more elements have been removed from an implementation of List.

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
ListRemoveEvent(java.util.List<L> source, int index, java.util.Collection<? extends E> affectedElements) Creates a new event object.
ListRemoveEvent(java.util.List<L> source, 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 removed from the list.

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

ListRemoveEvent

public ListRemoveEvent(java.util.List<L> source,
                       int index,
                       java.util.Collection<? extends E> affectedElements)

Creates a new event object.

Parameters:

source - the list instance that has been modified

affectedElements - a list of elements that have been removed

ListRemoveEvent

public ListRemoveEvent(java.util.List<L> source,
                       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

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

affectedElement - a list of elements that have been removed

Method Detail

getAffectedElements

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

Returns a collection of all elements that will be or have been removed from the list.

Note that this collection may contain elements have never been contained in the associated list, if this event is fired before the removal operation.

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()