SortedList

java.lang.Object
- <any>
- - javafx.collections.transformation.TransformationList<E,E>
  - - javafx.collections.transformation.SortedList<E>

```
public final class SortedList<E>
extends TransformationList<E,E>
```
Wraps an ObservableList and sorts its 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

Property Summary

All Methods Instance Methods Concrete Methods
Type Property and Description

<any> comparator
The comparator that denotes the order of this SortedList.

All Methods Instance Methods Concrete Methods
Type	Property and Description
`<any>`	`comparator` The comparator that denotes the order of this SortedList.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class SortedList.Element<E>

private static class SortedList.ElementComparator<E>

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 <any>`	`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`

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`addRemove(<any> c)`
`<any>`	`comparatorProperty()` The comparator that denotes the order of this SortedList.
`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()` Gets the value of the property comparator.
`int`	`getSourceIndex(int index)` Maps the index of this list's element to an index in the direct source list.
`int`	`getViewIndex(int index)` Maps the index of the direct source list's element to an index in this 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)` Sets the value of the property comparator.
`int`	`size()` Returns the number of elements in this list.
`protected void`	`sourceChanged(<any> c)` Called when a change from the source is triggered.
`private void`	`update(<any> c)`
`private void`	`updateIndices(int from, int viewFrom, int difference)`
`private void`	`updatePermutationIndexes(<any> change)`
`private void`	`updateUnsorted(<any> c)`

Methods inherited from class javafx.collections.transformation.TransformationList
getSource, getSourceIndexFor, isInTransformationChain

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - comparator
```
public final <any> comparatorProperty
```
    The comparator that denotes the order of this SortedList. Null for unordered SortedList.
    
    See Also:
    
    getComparator(), setComparator(Comparator)
- 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 <any> comparator
```
    The comparator that denotes the order of this SortedList. Null for unordered SortedList.
- Constructor Detail
  - SortedList
```
public SortedList(<any> 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(<any> 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(<any> 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 <any> comparatorProperty()
```
    The comparator that denotes the order of this SortedList. Null for unordered SortedList.
    
    See Also:
    
    getComparator(), setComparator(Comparator)
  - getComparator
```
public final java.util.Comparator<? super E> getComparator()
```
    Gets the value of the property comparator.
  - setComparator
```
public final void setComparator(java.util.Comparator<? super E> comparator)
```
    Sets the value of the property comparator.
  - get
```
public E get(int index)
```
    Returns the element at the specified position in this list.
    
    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.
    
    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()
  - getViewIndex
```
public int getViewIndex(int index)
```
    Description copied from class: TransformationList
    
    Maps the index of the direct source list's element to an index in this list.
    
    Specified by:
    
    getViewIndex in class TransformationList<E,E>
    
    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
    
    See Also:
    
    TransformationList.getSource(), TransformationList.getSourceIndex(int)
  - updatePermutationIndexes
```
private void updatePermutationIndexes(<any> change)
```
  - updateUnsorted
```
private void updateUnsorted(<any> 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(<any> c)
```
  - addRemove
```
private void addRemove(<any> c)
```

Class SortedList<E>

Property Summary

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class javafx.collections.transformation.TransformationList

Methods inherited from class java.lang.Object

Property Detail

comparator

Field Detail

elementComparator

sorted

perm

size

helper

tempElement

comparator

Constructor Detail

SortedList

SortedList

Method Detail

sourceChanged

comparatorProperty

getComparator

setComparator

get

size

doSortWithPermutationChange

getSourceIndex

getViewIndex

updatePermutationIndexes

updateUnsorted

ensureSize

updateIndices

findPosition

insertToMapping

setAllToMapping

removeFromMapping

removeAllFromMapping

update

addRemove