Class TransformationList<E,F>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

javafx.collections.ObservableListBase<E>

javafx.collections.transformation.TransformationList<E,F>

Type Parameters:

E - the type parameter of this list

F - the upper bound of the type of the source list

All Implemented Interfaces:

Iterable<E>, Collection<E>, List<E>, SequencedCollection<E>, Observable, ObservableList<E>

Direct Known Subclasses:

FilteredList, SortedList

public abstract class TransformationList<E,F>
extends ObservableListBase<E>

A base class for all lists that wrap another list in a way that changes (transforms) the wrapped list's elements, order, size, or structure. If the source list is observable, a listener is automatically added to it and the events are delegated to sourceChanged(javafx.collections.ListChangeListener.Change).

Since:

JavaFX 8.0

Field Summary

Fields declared in class AbstractList

modCount

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TransformationList(ObservableList<? extends F> source)	Creates a new Transformation list wrapped around the source list.

Method Summary

Modifier and Type	Method	Description
final ObservableList<? extends F>	getSource()	The source list specified in the constructor of this transformation list.
abstract int	getSourceIndex(int index)	Maps the index of this list's element to an index in the direct source list.
final int	getSourceIndexFor(ObservableList<?> list, int index)	Maps the index of this list's element to an index of the provided list.
abstract int	getViewIndex(int index)	Maps the index of the direct source list's element to an index in this list.
final boolean	isInTransformationChain(ObservableList<?> list)	Checks whether the provided list is in the chain under this TransformationList.
protected abstract void	sourceChanged(ListChangeListener.Change<? extends F> c)	Called when a change from the source is triggered.

Methods declared in class ObservableListBase

addAll, addListener, addListener, beginChange, endChange, fireChange, hasListeners, nextAdd, nextPermutation, nextRemove, nextRemove, nextReplace, nextSet, nextUpdate, remove, removeAll, removeListener, removeListener, retainAll, setAll, setAll

Modifier and Type	Method	Description
boolean	addAll(E... elements)	A convenience method for var-arg addition of elements.
final void	addListener(InvalidationListener listener)	Adds an InvalidationListener which will be notified whenever the Observable becomes invalid.
final void	addListener(ListChangeListener<? super E> listener)	Add a listener to this observable list.
protected final void	beginChange()	Begins a change block.
protected final void	endChange()	Ends the change block.
protected final void	fireChange(ListChangeListener.Change<? extends E> change)	Notifies all listeners of a change
protected final boolean	hasListeners()	Returns true if there are some listeners registered for this list.
protected final void	nextAdd(int from, int to)	Adds a new add operation to the change.
protected final void	nextPermutation(int from, int to, int[] perm)	Adds a new permutation operation to the change.
protected final void	nextRemove(int idx, E removed)	Adds a new remove operation to the change with single item removed.
protected final void	nextRemove(int idx, List<? extends E> removed)	Adds a new remove operation to the change with multiple items removed.
protected final void	nextReplace(int from, int to, List<? extends E> removed)	Adds a new replace operation to the change.
protected final void	nextSet(int idx, E old)	Adds a new set operation to the change.
protected final void	nextUpdate(int pos)	Adds a new update operation to the change.
void	remove(int from, int to)	A simplified way of calling sublist(from, to).clear().
boolean	removeAll(E... elements)	A convenience method for var-arg usage of the removeAll method.
final void	removeListener(InvalidationListener listener)	Removes the given listener from the list of listeners, that are notified whenever the value of the Observable becomes invalid.
final void	removeListener(ListChangeListener<? super E> listener)	Tries to remove a listener from this observable list.
boolean	retainAll(E... elements)	A convenience method for var-arg usage of the retainAll method.
boolean	setAll(E... elements)	Clears the ObservableList and adds all the elements passed as var-args.
boolean	setAll(Collection<? extends E> col)	Clears the ObservableList and adds all elements from the collection.

Methods declared in class AbstractList

add, add, addAll, clear, equals, get, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList

Methods declared in class AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, size, toArray, toArray, toString

Methods declared in class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods declared in interface Collection

parallelStream, removeIf, stream, toArray

Methods declared in interface Iterable

forEach

Methods declared in interface List

addAll, addFirst, addLast, contains, containsAll, getFirst, getLast, isEmpty, remove, removeAll, removeFirst, removeLast, replaceAll, retainAll, reversed, size, sort, spliterator, toArray, toArray

Methods declared in interface Observable

subscribe

Modifier and Type	Method	Description
default Subscription	subscribe(Runnable invalidationSubscriber)	Creates a Subscription on this Observable which calls invalidationSubscriber whenever it becomes invalid.

Methods declared in interface ObservableList

filtered, replaceRange, sorted, sorted

Modifier and Type	Method	Description
default FilteredList<E>	filtered(Predicate<E> predicate)	Creates a FilteredList wrapper of this list using the specified predicate.
default boolean	replaceRange(int from, int to, Collection<? extends E> col)	Replaces the elements in the range [from, to) with the elements from the given collection.
default SortedList<E>	sorted()	Creates a SortedList wrapper of this list with the natural ordering.
default SortedList<E>	sorted(Comparator<E> comparator)	Creates a SortedList wrapper of this list using the specified comparator.

Constructor Details

TransformationList

protected TransformationList(ObservableList<? extends F> source)

Creates a new Transformation list wrapped around the source list.

Parameters:

source - the wrapped list

Method Details

getSource

public final ObservableList<? extends F> getSource()

The source list specified in the constructor of this transformation list.

Returns:

The List that is directly wrapped by this TransformationList

isInTransformationChain

public final boolean isInTransformationChain(ObservableList<?> list)

Checks whether the provided list is in the chain under this TransformationList. This means the list is either the direct source as returned by getSource() or the direct source is a TransformationList, and the list is in it's transformation chain.

Parameters:

list - the list to check

Returns:

true if the list is in the transformation chain as specified above.

sourceChanged

protected abstract void sourceChanged(ListChangeListener.Change<? extends F> c)

Called when a change from the source is triggered.

Parameters:

c - the change

getSourceIndex

public abstract int getSourceIndex(int index)

Maps the index of this list's element to an index in the direct source list.

Parameters:

index - the index in this list

Returns:

the index of the element's origin in the source list

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

See Also:

• getSource()

getSourceIndexFor

public final int getSourceIndexFor(ObservableList<?> list,
 int index)

Maps the index of this list's element to an index of the provided list. The list must be in the transformation chain.

Parameters:

list - a list from the transformation chain

index - the index of an element in this list

Returns:

the index of the element's origin in the provided list

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

See Also:

• isInTransformationChain(javafx.collections.ObservableList)

getViewIndex

public abstract int getViewIndex(int index)

Maps the index of the direct source list's element to an index in this list.

Parameters:

index - the index in the source list

Returns:

the index of the element in this list if it is contained in this list or negative value otherwise

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= getSource().size())

Since:

9

See Also:

• getSource()
• getSourceIndex(int)