APIdia Launch Partner
Top Description Fields Constructors Methods
com.sun.javafx.collections

public Class ObservableListWrapper<E>

extends ModifiableObservableListBase<E>
implements SortableList<E>, RandomAccess
Class Inheritance
All Implemented Interfaces
java.util.RandomAccess, com.sun.javafx.collections.SortableList, javafx.collections.ObservableList, javafx.beans.Observable, java.util.List, java.util.SequencedCollection, java.util.Collection, java.lang.Iterable
Known Direct Subclasses
com.sun.javafx.collections.TrackableObservableList
Imports
java.util.BitSet, .Collection, .Comparator, .List, .Objects, .RandomAccess, com.sun.javafx.collections.NonIterableChange.SimplePermutationChange, javafx.beans.InvalidationListener, .Observable, javafx.collections.ModifiableObservableListBase, javafx.util.Callback
A List wrapper class that implements observability.

Field Summary

Modifier and TypeField and Description
private final List<E>
backingList

private final ElementObserver<E>
elementObserver

private SortHelper
helper

Constructor Summary

AccessConstructor and Description
public
ObservableListWrapper(List<E> list)

public
ObservableListWrapper(List<E> list, Callback<E, Observable[]> extractor)

Method Summary

Modifier and TypeMethod and Description
public void
clear()

Overrides java.util.AbstractList.clear.

Implements java.util.List.clear, java.util.Collection.clear.

Removes all of the elements from this list (optional operation).

public boolean
contains(Object o)

Overrides java.util.AbstractCollection.contains.

Implements java.util.List.contains, java.util.Collection.contains.

Returns true if this list contains the specified element.

public boolean
containsAll(Collection<?> c)

Overrides java.util.AbstractCollection.containsAll.

Implements java.util.List.containsAll, java.util.Collection.containsAll.

Returns true if this list contains all of the elements of the specified collection.

protected void
doAdd(int index, E element)

Implements abstract javafx.collections.ModifiableObservableListBase.doAdd.

Adds the element to the List at the position of index.

protected E
doRemove(int index)

Implements abstract javafx.collections.ModifiableObservableListBase.doRemove.

Removes the element at position of index.

protected E
doSet(int index, E element)

Implements abstract javafx.collections.ModifiableObservableListBase.doSet.

Sets the element in the List at the position of index.

public void
doSort(Comparator<? super E> comparator)

Implements com.sun.javafx.collections.SortableList.doSort.

Sorts the list and reports it as one change event.

public E
get(int index)

Implements abstract javafx.collections.ModifiableObservableListBase.get.

Implements java.util.List.get.

Returns the element at the specified position in this list.

private SortHelper
getSortHelper()

public int
indexOf(Object o)

Overrides java.util.AbstractList.indexOf.

Implements java.util.List.indexOf.

Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.

public int
lastIndexOf(Object o)

Overrides java.util.AbstractList.lastIndexOf.

Implements java.util.List.lastIndexOf.

Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.

public void
remove(int fromIndex, int toIndex)

Overrides javafx.collections.ObservableListBase.remove.

Implements javafx.collections.ObservableList.remove.

A simplified way of calling sublist(from, to).clear().

public boolean
removeAll(Collection<?> c)

Overrides javafx.collections.ModifiableObservableListBase.removeAll.

Implements java.util.List.removeAll, java.util.Collection.removeAll.

Removes from this list all of its elements that are contained in the specified collection (optional operation).

public boolean
retainAll(Collection<?> c)

Overrides javafx.collections.ModifiableObservableListBase.retainAll.

Implements java.util.List.retainAll, java.util.Collection.retainAll.

Retains only the elements in this list that are contained in the specified collection (optional operation).

public int
size()

Implements abstract javafx.collections.ModifiableObservableListBase.size.

Implements java.util.List.size, java.util.Collection.size.

Returns the number of elements in this list.

Inherited from javafx.collections.ModifiableObservableListBase:
addaddAlladdAllremoveremoveremoveRangereplaceRangesetsetAllsubList

Field Detail

backingListback to summary
private final List<E> backingList
elementObserverback to summary
private final ElementObserver<E> elementObserver
helperback to summary
private SortHelper helper

Constructor Detail

ObservableListWrapperback to summary
public ObservableListWrapper(List<E> list)
ObservableListWrapperback to summary
public ObservableListWrapper(List<E> list, Callback<E, Observable[]> extractor)

Method Detail

clearback to summary
public void clear()

Overrides java.util.AbstractList.clear.

Implements java.util.List.clear, java.util.Collection.clear.

Doc from java.util.List.clear.

Removes all of the elements from this list (optional operation). The list will be empty after this call returns.

Annotations
@Override
containsback to summary
public boolean contains(Object o)

Overrides java.util.AbstractCollection.contains.

Implements java.util.List.contains, java.util.Collection.contains.

Doc from java.util.List.contains.

Returns true if this list contains the specified element. More formally, returns true if and only if this list contains at least one element e such that Objects.equals(o, e).

Annotations
@Override
containsAllback to summary
public boolean containsAll(Collection<?> c)

Overrides java.util.AbstractCollection.containsAll.

Implements java.util.List.containsAll, java.util.Collection.containsAll.

Doc from java.util.List.containsAll.

Returns true if this list contains all of the elements of the specified collection.

Annotations
@Override
doAddback to summary
protected void doAdd(int index, E element)

Implements abstract javafx.collections.ModifiableObservableListBase.doAdd.

Doc from javafx.collections.ModifiableObservableListBase.doAdd.

Adds the element to the List at the position of index.

For the description of possible exceptions, please refer to the documentation of add(java.lang.Object) method.

Annotations
@Override
doRemoveback to summary
protected E doRemove(int index)

Implements abstract javafx.collections.ModifiableObservableListBase.doRemove.

Doc from javafx.collections.ModifiableObservableListBase.doRemove.

Removes the element at position of index.

Annotations
@Override
doSetback to summary
protected E doSet(int index, E element)

Implements abstract javafx.collections.ModifiableObservableListBase.doSet.

Doc from javafx.collections.ModifiableObservableListBase.doSet.

Sets the element in the List at the position of index.

For the description of possible exceptions, please refer to the documentation of set(int, java.lang.Object) method.

Annotations
@Override
doSortback to summary
public void doSort(Comparator<? super E> comparator)

Implements com.sun.javafx.collections.SortableList.doSort.

Doc from com.sun.javafx.collections.SortableList.doSort.

Sorts the list and reports it as one change event.

Annotations
@Override
getback to summary
public E get(int index)

Implements abstract javafx.collections.ModifiableObservableListBase.get.

Implements java.util.List.get.

Doc from java.util.List.get.

Returns the element at the specified position in this list.

Annotations
@Override
getSortHelperback to summary
private SortHelper getSortHelper()
indexOfback to summary
public int indexOf(Object o)

Overrides java.util.AbstractList.indexOf.

Implements java.util.List.indexOf.

Doc from java.util.List.indexOf.

Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the lowest index i such that Objects.equals(o, get(i)), or -1 if there is no such index.

Annotations
@Override
lastIndexOfback to summary
public int lastIndexOf(Object o)

Overrides java.util.AbstractList.lastIndexOf.

Implements java.util.List.lastIndexOf.

Doc from java.util.List.lastIndexOf.

Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the highest index i such that Objects.equals(o, get(i)), or -1 if there is no such index.

Annotations
@Override
removeback to summary
public void remove(int fromIndex, int toIndex)

Overrides javafx.collections.ObservableListBase.remove.

Implements javafx.collections.ObservableList.remove.

Doc from javafx.collections.ObservableList.remove.

A simplified way of calling sublist(from, to).clear(). As this is a common operation, ObservableList has this method for convenient usage.

Annotations
@Override
removeAllback to summary
public boolean removeAll(Collection<?> c)

Overrides javafx.collections.ModifiableObservableListBase.removeAll.

Implements java.util.List.removeAll, java.util.Collection.removeAll.

Doc from java.util.List.removeAll.

Removes from this list all of its elements that are contained in the specified collection (optional operation).

Annotations
@Override
retainAllback to summary
public boolean retainAll(Collection<?> c)

Overrides javafx.collections.ModifiableObservableListBase.retainAll.

Implements java.util.List.retainAll, java.util.Collection.retainAll.

Doc from java.util.List.retainAll.

Retains only the elements in this list that are contained in the specified collection (optional operation). In other words, removes from this list all of its elements that are not contained in the specified collection.

Annotations
@Override
sizeback to summary
public int size()

Implements abstract javafx.collections.ModifiableObservableListBase.size.

Implements java.util.List.size, java.util.Collection.size.

Doc from java.util.List.size.

Returns the number of elements in this list. If this list contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Annotations
@Override