javafx.collections.transformation

Class SortedList<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

javafx.collections.ObservableListBase<E>

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

javafx.collections.transformation.SortedList<E>

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, java.util.List<E>, Observable, ObservableList<E>

public final class SortedList<E>
extends TransformationList<E,E>

Wraps an ObservableList and sorts it's content. All changes in the ObservableList are propagated immediately to the SortedList. Note: invalid SortedList (as a result of broken comparison) doesn't send any notification to listeners on becoming valid again.

Since:

JavaFX 8.0

See Also:

TransformationList

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	SortedList.Element<E>
private static class	SortedList.ElementComparator<E>

Field Summary

Fields

Modifier and Type	Field and Description
private ObjectProperty<java.util.Comparator<? super E>>	comparator The comparator that denotes the order of this SortedList.
private java.util.Comparator<SortedList.Element<E>>	elementComparator
private SortHelper	helper
private int[]	perm
private int	size
private SortedList.Element<E>[]	sorted
private SortedList.Element<E>	tempElement

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
SortedList(ObservableList<? extends E> source) Constructs a new unordered SortedList wrapper around the source list.
SortedList(ObservableList<? extends E> source, java.util.Comparator<? super E> comparator) Creates a new SortedList wrapped around the source list.

Method Summary

Modifier and Type	Method and Description
private void	addRemove(ListChangeListener.Change<? extends E> c)
ObjectProperty<java.util.Comparator<? super E>>	comparatorProperty()
private void	doSortWithPermutationChange()
private void	ensureSize(int size)
private int	findPosition(E e)
E	get(int index) Returns the element at the specified position in this list.
java.util.Comparator<? super E>	getComparator()
int	getSourceIndex(int index) Maps the index of this list's element to an index in the direct source list.
private void	insertToMapping(E e, int idx)
private void	removeAllFromMapping()
private void	removeFromMapping(int idx, E e)
private void	setAllToMapping(java.util.List<? extends E> list, int to)
void	setComparator(java.util.Comparator<? super E> comparator)
int	size() Returns the number of elements in this list.
protected void	sourceChanged(ListChangeListener.Change<? extends E> c) Called when a change from the source is triggered.
private void	update(ListChangeListener.Change<? extends E> c)
private void	updateIndices(int from, int viewFrom, int difference)
private void	updatePermutationIndexes(ListChangeListener.Change<? extends E> change)
private void	updateUnsorted(ListChangeListener.Change<? extends E> c)

Methods inherited from class javafx.collections.transformation.TransformationList

getSource, getSourceIndexFor, isInTransformationChain

Methods inherited from class javafx.collections.ObservableListBase

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

Methods inherited from class java.util.AbstractList

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

Methods inherited from class java.util.AbstractCollection

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface javafx.collections.ObservableList

addAll, addListener, filtered, remove, removeAll, removeListener, retainAll, setAll, setAll, sorted, sorted

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, sort, spliterator, subList, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface javafx.beans.Observable

addListener, removeListener

Field Detail

elementComparator

private java.util.Comparator<SortedList.Element<E>> elementComparator

sorted

private SortedList.Element<E>[] sorted

perm

private int[] perm

size

private int size

helper

private final SortHelper helper

tempElement

private final SortedList.Element<E> tempElement

comparator

private ObjectProperty<java.util.Comparator<? super E>> comparator

The comparator that denotes the order of this SortedList. Null for unordered SortedList.

Constructor Detail

SortedList

public SortedList(ObservableList<? extends E> source,
                  java.util.Comparator<? super E> comparator)

Creates a new SortedList wrapped around the source list. The source list will be sorted using the comparator provided. If null is provided, the list stays unordered and is equal to the source list.

Parameters:

source - a list to wrap

comparator - a comparator to use or null for unordered List

SortedList

public SortedList(ObservableList<? extends E> source)

Constructs a new unordered SortedList wrapper around the source list.

Parameters:

source - the source list

See Also:

SortedList(javafx.collections.ObservableList, java.util.Comparator)

Method Detail

sourceChanged

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

Description copied from class: TransformationList

Called when a change from the source is triggered.

Specified by:

sourceChanged in class TransformationList<E,E>

Parameters:

c - the change

comparatorProperty

public final ObjectProperty<java.util.Comparator<? super E>> comparatorProperty()

getComparator

public final java.util.Comparator<? super E> getComparator()

setComparator

public final void setComparator(java.util.Comparator<? super E> comparator)

get

public E get(int index)

Returns the element at the specified position in this list.

Specified by:

get in interface java.util.List<E>

Specified by:

get in class java.util.AbstractList<E>

Parameters:

index - index of the element to return

Returns:

the element at the specified position in this list

Throws:

java.lang.IndexOutOfBoundsException

size

public int size()

Returns the number of elements in this list.

Specified by:

size in interface java.util.Collection<E>

Specified by:

size in interface java.util.List<E>

Specified by:

size in class java.util.AbstractCollection<E>

Returns:

the number of elements in this list

doSortWithPermutationChange

private void doSortWithPermutationChange()

getSourceIndex

public int getSourceIndex(int index)

Description copied from class: TransformationList

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

Specified by:

getSourceIndex in class TransformationList<E,E>

Parameters:

index - the index in this list

Returns:

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

See Also:

TransformationList.getSource()

updatePermutationIndexes

private void updatePermutationIndexes(ListChangeListener.Change<? extends E> change)

updateUnsorted

private void updateUnsorted(ListChangeListener.Change<? extends E> c)

ensureSize

private void ensureSize(int size)

updateIndices

private void updateIndices(int from,
                           int viewFrom,
                           int difference)

findPosition

private int findPosition(E e)

insertToMapping

private void insertToMapping(E e,
                             int idx)

setAllToMapping

private void setAllToMapping(java.util.List<? extends E> list,
                             int to)

removeFromMapping

private void removeFromMapping(int idx,
                               E e)

removeAllFromMapping

private void removeAllFromMapping()

update

private void update(ListChangeListener.Change<? extends E> c)

addRemove

private void addRemove(ListChangeListener.Change<? extends E> c)