Package org.reactfx.collection
Interface ListModificationLike<E>
- Type Parameters:
E
- type of list elements.
- All Known Subinterfaces:
ListModification<E>
,MaterializedListModification<E>
,QuasiListModification<E>
- All Known Implementing Classes:
ListModificationImpl
,MaterializedListModificationImpl
,QuasiListModificationImpl
interface ListModificationLike<E>
Describes an elementary modification made to a list. Elementary modification
is represented by the position in the list where the change occurred
(
getFrom()
), a list of elements removed by the modification
(getRemoved()
), and the number of added elements replacing the
removed elements (getAddedSize()
).
Subtypes of this interface differ in how they refer to the added elements:
ListModification
holds a reference to the observable list in which the modification occurred and theListModification.getAddedSubList()
method returns a sublist view of the original observable list. Such sublist is valid only until the next list modification.MaterializedListModification
has its own copy of added elements (MaterializedListModification.getAdded()
), thus the validity of the list of added elements returned fromgetAdded()
is not restricted.QuasiListModification
does not provide a way to get the added elements directly, but has to be combined with the observable list to obtain ListModification (QuasiListModification.instantiate(QuasiListModification, ObservableList)
) or MaterializedListModification (QuasiListModification.materialize(QuasiListModification, ObservableList)
).
-
Method Summary
Modifier and TypeMethodDescriptionint
Returns the number of items added by this change.int
getFrom()
Returns the position in the list where this change occurred.Returns an immutable list of elements removed by this change.default int
Returns the number of items removed by this change.default int
getTo()
Returns the end position of the change in the modified list.
-
Method Details
-
getFrom
int getFrom()Returns the position in the list where this change occurred. -
getRemovedSize
default int getRemovedSize()Returns the number of items removed by this change. -
getAddedSize
int getAddedSize()Returns the number of items added by this change. -
getTo
default int getTo()Returns the end position of the change in the modified list. The returned value is equal togetFrom() + getAddedSize()
. -
getRemoved
Returns an immutable list of elements removed by this change. Before the change occurred, the first element of the returned list was at indexgetFrom()
in the original list. If no elements were removed by this change, returns an empty list. The size of the returned list is equal to the value returned bygetRemovedSize()
.
-