YList (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.algorithms.YList

All Implemented Interfaces:

ICollection<Object>, IEnumerable<Object>, Iterable<Object>, Collection<Object>, List<Object>

Direct Known Subclasses:

EdgeList, NodeList
```
public class YList
extends Object
implements List<Object>, ICollection<Object>
```
An implementation of a doubly linked list that provides direct access to the cells that store the elements.
The cells are represented by class ListCell.

This class supports fast access and removal operations, specifically, it is possible to remove an element in constant time (i.e. O(1)) given a reference to its list cell.

Class YList supports iteration over the elements either by using the list cells directly (methods FirstCell/LastCell together with succCell(ListCell)/predCell(ListCell), respectively) or by means of a cursor (cursor()).

Furthermore, YList offers its own sort() method. Note that this class also provides all relevant methods to use the list like a stack data type.

This implementation permits null as values. It implements the List interface but does not support the subList(int, int) method. The implementation of this method will throw an UnsupportedOperationException if invoked. The cursor() returned by instances of this class is not fail fast.

Field Summary
- Fields inherited from interface com.yworks.yfiles.utils.ICollection
  EMPTY

Constructor Summary

Constructors
Constructor and Description
`YList()` Creates an empty doubly linked list.
`YList(ICursor c)` Creates a list that is initialized with the elements provided by the given YCursor object.
`YList(ICursor c, IDataProvider predicate)` Creates a list that is initialized with those elements from the given YCursor object for which the given data provider returns `true` upon calling its `getBool` method.
`YList(IEnumerator e)` Creates a list that is initialized with the elements provided by the given enumerator object.
`YList(Iterable<Object> c)` Creates a list that is initialized with the elements provided by the given Collection object.
`YList(Object[] a)` Creates a list that is initialized with the elements provided by the given array of objects.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(int index, Object element)`
`boolean`	`add(Object o)` Same as `addLast(Object)`.
`boolean`	`addAll(Collection<? extends Object> collection)` Appends all elements provided by the given collection to this list.
`void`	`addAll(ICursor c)` Appends all elements provided by the given cursor to this list.
`boolean`	`addAll(int index, Collection<? extends Object> c)`
`ListCell`	`addFirst(Object o)` Inserts the given object at the head of this list.
`void`	`addFirstCell(ListCell cell)` Adds a formerly removed ListCell object at the head of this list.
`ListCell`	`addLast(Object o)` Inserts the given object at the tail of this list.
`void`	`addLastCell(ListCell cell)` Adds a formerly removed ListCell object at the tail of this list.
`void`	`clear()` Removes all elements from this list.
`boolean`	`contains(Object o)` Whether or not this list contains the given element.
`boolean`	`containsAll(Collection<? extends Object> collection)` Whether or not this list contains all the elements in the given collection.
`void`	`copyTo(Object[] array, int arrayIndex)` Copies the elements of this collection to an array, starting at the specified array index.
`void`	`copyTo(Object array, int index)` Copies the elements of this collection to an `Object`, starting at a particular `Object` index.
`ICursor`	`cursor()` Returns a cursor for this list.
`ListCell`	`cyclicPred(ListCell c)` Returns the cyclic predecessor cell of the given list cell.
`ListCell`	`cyclicSucc(ListCell c)` Returns the cyclic successor cell of the given list cell.
`Object`	`elementAt(int i)` Returns the i-th element of this list.
`IEnumerator<Object>`	`enumerator()` Returns an enumerator that iterates through this collection.
`boolean`	`equals(Object other)`
`ListCell`	`findCell(Object o)` Returns the `ListCell` where object `o` is stored.
`Object`	`first()` Gets the first element of this list.
`ListCell`	`firstCell()` Gets the first cell of this list.
`Object`	`get(int index)`
`ListCell`	`getCell(int index)` Gets the cell at the given index.
`Object`	`getInfo(ListCell c)` Returns the element stored in the given list cell.
`int`	`hashCode()`
`int`	`indexOf(Object obj)` Returns the zero-based index of the given element in this list.
`ListCell`	`insertAfter(Object o, ListCell refCell)` Inserts the given object into this list with respect to a given reference list cell.
`ListCell`	`insertBefore(Object o, ListCell refCell)` Inserts the given object into this list with respect to a given reference list cell.
`void`	`insertCellAfter(ListCell cellToInsert, ListCell refCell)` Inserts a formerly removed ListCell object into this list with respect to a given reference list cell.
`void`	`insertCellBefore(ListCell cellToInsert, ListCell refCell)` Inserts a formerly removed ListCell object into this list with respect to a given reference list cell.
`boolean`	`isEmpty()` Checks whether this list contains elements.
`Object`	`last()` Gets the last element of this list.
`ListCell`	`lastCell()` Gets the last cell of this list.
`int`	`lastIndexOf(Object o)`
`ListIterator`	`listIterator()`
`Stream<Object>`	`parallelStream()` Returns a parallel `Stream` using the elements of this enumerable.
`Object`	`peek()` Equivalent to `First`.
`Object`	`pop()` Removes the first element from this list and returns it.
`Object`	`popLast()` Removes the last element from this list and returns it.
`ListCell`	`predCell(ListCell c)` Returns the predecessor cell of the given list cell.
`ListCell`	`push(Object o)` Equivalent to `addFirst(Object)`.
`boolean`	`remove(Object o)` Removes the given object from this list.
`boolean`	`removeAll(Collection<? extends Object> collection)` Removes the given collection of objects from this list.
`Object`	`removeAt(ICursor c)` Removes the element pointed to by the given YCursor object.
`Object`	`removeCell(ListCell c)` Removes the given list cell, and hence the element stored in it, from this list.
`boolean`	`retainAll(Collection<? extends Object> collection)` Retains only those elements in this list which are contained in the given collection.
`void`	`reverse()` Reverses the sequence of elements in this list.
`Object`	`set(int index, Object element)`
`void`	`setInfo(ListCell c, Object value)` Updates the element stored in the given list cell with the given object.
`int`	`size()` Gets the number of elements in this list.
`void`	`sort()` Sorts the elements in this list into ascending order, according to their natural ordering.
`void`	`sort(Comparator<Object> comp)` Sorts the elements in this list according to the given comparator.
`void`	`splice(YList list)` Transfers the contents of the given list to the end of this list.
`Stream<Object>`	`stream()` Returns a sequential `Stream` using the elements of this enumerable.
`List<Object>`	`subList(int fromIndex, int toIndex)`
`ListCell`	`succCell(ListCell c)` Returns the successor cell of the given list cell.
`Object[]`	`toArray()` Returns an array representation of this list.
`Object[]`	`toArray(Object[] a)` Returns an array containing all list elements in the correct order.
`String`	`toString()` Returns a string representation of this List.

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

Methods inherited from interface java.util.List
iterator, listIterator, remove, replaceAll, spliterator

Methods inherited from interface com.yworks.yfiles.utils.ICollection
iterator

Methods inherited from interface com.yworks.yfiles.utils.IEnumerable
concat, concat, create, create

Methods inherited from interface java.util.Collection
removeIf

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - YList
```
public YList()
```
    Creates an empty doubly linked list.
  - YList
```
public YList(ICursor c)
```
    Creates a list that is initialized with the elements provided by the given YCursor object.
  - YList
```
public YList(ICursor c,
             IDataProvider predicate)
```
    Creates a list that is initialized with those elements from the given YCursor object for which the given data provider returns true upon calling its getBool method.
    
    Parameters:
    
    c - A cursor providing objects that should be added to this list.
    
    predicate - A data provider that acts as a inclusion predicate for each object accessible by the given cursor.
  - YList
```
public YList(IEnumerator e)
```
    Creates a list that is initialized with the elements provided by the given enumerator object.
    Creates a list that is initialized with the elements provided by the given enumerator object.
  - YList
```
public YList(Iterable<Object> c)
```
    Creates a list that is initialized with the elements provided by the given Collection object.
  - YList
```
public YList(Object[] a)
```
    Creates a list that is initialized with the elements provided by the given array of objects.
- Method Detail
  - add
```
public final void add(int index,
                      Object element)
```
    Specified by:
    
    add in interface List<Object>
  - add
```
public final boolean add(Object o)
```
    Same as addLast(Object).
    
    Specified by:
    
    add in interface Collection<Object>
    
    Specified by:
    
    add in interface List<Object>
    
    Returns:
    
    true
  - addAll
```
public final boolean addAll(Collection<? extends Object> collection)
```
    Appends all elements provided by the given collection to this list.
    
    Specified by:
    
    addAll in interface ICollection<Object>
    
    Specified by:
    
    addAll in interface Collection<Object>
    
    Specified by:
    
    addAll in interface List<Object>
    
    Returns:
    
    Whether there have been elements appended.
  - addAll
```
public final void addAll(ICursor c)
```
    Appends all elements provided by the given cursor to this list.
    The cursor will be moved from its given position to the end.
    
    Be aware that a statement like aList.append(aList.cursor()) results in an infinite recursion.
  - addAll
```
public final boolean addAll(int index,
                            Collection<? extends Object> c)
```
    Specified by:
    
    addAll in interface List<Object>
  - addFirst
```
public final ListCell addFirst(Object o)
```
    Inserts the given object at the head of this list.
    
    Returns:
    
    The newly created ListCell object that stores the given object.
  - addFirstCell
```
public final void addFirstCell(ListCell cell)
```
    Adds a formerly removed ListCell object at the head of this list.
    Attention: If the ListCell object is still part of any list, then that list will be corrupted afterwards.
    
    Parameters:
    
    cell - A list cell which is not part of any list.
  - addLast
```
public final ListCell addLast(Object o)
```
    Inserts the given object at the tail of this list.
    
    Returns:
    
    The newly created ListCell object that stores the given object.
  - addLastCell
```
public final void addLastCell(ListCell cell)
```
    Adds a formerly removed ListCell object at the tail of this list.
    Attention: If the ListCell object is still part of any list, then that list will be corrupted afterwards.
    
    Parameters:
    
    cell - A list cell which is not part of any list.
  - clear
```
public final void clear()
```
    Removes all elements from this list.
    
    Specified by:
    
    clear in interface Collection<Object>
    
    Specified by:
    
    clear in interface List<Object>
  - contains
```
public final boolean contains(Object o)
```
    Whether or not this list contains the given element.
    Equality of elements is defined by the Object.equals(Object) method.
    
    Specified by:
    
    contains in interface Collection<Object>
    
    Specified by:
    
    contains in interface List<Object>
  - containsAll
```
public final boolean containsAll(Collection<? extends Object> collection)
```
    Whether or not this list contains all the elements in the given collection.
    Equality of elements is defined by the Object.equals(Object) method.
    
    Specified by:
    
    containsAll in interface ICollection<Object>
    
    Specified by:
    
    containsAll in interface Collection<Object>
    
    Specified by:
    
    containsAll in interface List<Object>
  - copyTo
```
public final void copyTo(Object[] array,
                         int arrayIndex)
```
    Copies the elements of this collection to an array, starting at the specified array index.
    
    Parameters:
    
    array - The one-dimensional array that is the destination of the elements copied from this collection.
    
    arrayIndex - The zero-based index in array at which copying begins.
  - copyTo
```
public void copyTo(Object array,
                   int index)
```
    Copies the elements of this collection to an Object, starting at a particular Object index.
    
    Parameters:
    
    array - The one-dimensional Object that is the destination of the elements copied from this collection. The Object must have zero-based indexing.
    
    index - The zero-based index in array at which copying begins.
  - cursor
```
public final ICursor cursor()
```
    Returns a cursor for this list.
    All cursor operations are supported. This cursor implementation is not fail-fast and continues to work if this list is modified during the traversal as long as the current ListCell the cursor points at is this in this list or has been removed from this list but has not been added to another instance since then.
  - cyclicPred
```
public final ListCell cyclicPred(ListCell c)
```
    Returns the cyclic predecessor cell of the given list cell.
    The last cell is returned as the cyclic predecessor of the first list cell.
  - cyclicSucc
```
public final ListCell cyclicSucc(ListCell c)
```
    Returns the cyclic successor cell of the given list cell.
    The first cell is returned as the cyclic successor of the last list cell.
  - elementAt
```
public final Object elementAt(int i)
```
    Returns the i-th element of this list.
    
    Precondition:
    i is a valid index, i.e., i >= 0 && i < size().
  - enumerator
```
public final IEnumerator<Object> enumerator()
```
    Returns an enumerator that iterates through this collection.
    
    Specified by:
    
    enumerator in interface IEnumerable<Object>
    
    Returns:
    
    An IEnumerator that can be used to iterate through this collection.
  - equals
```
public boolean equals(Object other)
```
    Specified by:
    
    equals in interface Collection<Object>
    
    Specified by:
    
    equals in interface List<Object>
    
    Overrides:
    
    equals in class Object
  - findCell
```
public final ListCell findCell(Object o)
```
    Returns the ListCell where object o is stored.
    This operation returns null, if no such cell exists. Equality of elements is defined by the Object.equals(Object) method. The first element in the list that matches that criteria is returned.
    
    Returns:
    
    the ListCell that contains the element or null if no such ListCell was found
  - first
```
public final Object first()
```
    Gets the first element of this list.
    
    Precondition:
    !isEmpty().
    
    Returns:
    
    The First.
  - firstCell
```
public final ListCell firstCell()
```
    Gets the first cell of this list.
    
    Precondition:
    !isEmpty().
    
    Returns:
    
    The FirstCell.
  - get
```
public final Object get(int index)
```
    Specified by:
    
    get in interface List<Object>
  - getCell
```
public final ListCell getCell(int index)
```
    Gets the cell at the given index.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is negative or greater or equal than the Count
    
    Parameters:
    
    index - the zero-based index of the cell in this list.
    
    Returns:
    
    The cell.
  - getInfo
```
public final Object getInfo(ListCell c)
```
    Returns the element stored in the given list cell.
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Collection<Object>
    
    Specified by:
    
    hashCode in interface List<Object>
    
    Overrides:
    
    hashCode in class Object
  - indexOf
```
public final int indexOf(Object obj)
```
    Returns the zero-based index of the given element in this list.
    If the given element is not in the list, -1 is returned.
    
    Specified by:
    
    indexOf in interface List<Object>
  - insertAfter
```
public final ListCell insertAfter(Object o,
                                  ListCell refCell)
```
    Inserts the given object into this list with respect to a given reference list cell.
    The (newly created) list cell that stores the object is inserted right after the reference list cell refCell.
    
    If refCell == null, the given object is inserted at the head of the list.
    
    Precondition:
    refCell must be part of this list.
    
    Parameters:
    
    o - The object to be inserted.
    
    refCell - The list cell used to reference the position.
    
    Returns:
    
    The newly created ListCell object that stores object o.
  - insertBefore
```
public final ListCell insertBefore(Object o,
                                   ListCell refCell)
```
    Inserts the given object into this list with respect to a given reference list cell.
    The (newly created) list cell that stores the object is inserted right before the reference list cell refCell.
    
    If refCell == null, the given object is appended to the list.
    
    Precondition:
    refCell must be part of this list.
    
    Parameters:
    
    o - The object to be inserted.
    
    refCell - The list cell used to reference the position.
    
    Returns:
    
    The newly created ListCell object that stores object o.
  - insertCellAfter
```
public final void insertCellAfter(ListCell cellToInsert,
                                  ListCell refCell)
```
    Inserts a formerly removed ListCell object into this list with respect to a given reference list cell.
    The ListCell object is inserted right after the reference list cell refCell.
    
    Attention: If the ListCell object is still part of any list, then that list will be corrupted afterwards.
    
    Precondition:
    refCell must be part of this list.
    
    Parameters:
    
    cellToInsert - A list cell which is not part of any list.
    
    refCell - The list cell used to reference the position.
  - insertCellBefore
```
public final void insertCellBefore(ListCell cellToInsert,
                                   ListCell refCell)
```
    Inserts a formerly removed ListCell object into this list with respect to a given reference list cell.
    The ListCell object is inserted right before the reference list cell refCell.
    
    Attention: If the ListCell object is still part of any list, then that list will be corrupted afterwards.
    
    Precondition:
    refCell must be part of this list.
    
    Parameters:
    
    cellToInsert - A list cell which is not part of any list.
    
    refCell - The list cell used to reference the position.
  - isEmpty
```
public final boolean isEmpty()
```
    Checks whether this list contains elements.
    
    Specified by:
    
    isEmpty in interface ICollection<Object>
    
    Specified by:
    
    isEmpty in interface Collection<Object>
    
    Specified by:
    
    isEmpty in interface List<Object>
  - last
```
public final Object last()
```
    Gets the last element of this list.
    
    Precondition:
    !isEmpty().
    
    Returns:
    
    The Last.
  - lastCell
```
public final ListCell lastCell()
```
    Gets the last cell of this list.
    
    Precondition:
    !isEmpty().
    
    Returns:
    
    The LastCell.
  - lastIndexOf
```
public final int lastIndexOf(Object o)
```
    Specified by:
    
    lastIndexOf in interface List<Object>
  - listIterator
```
public final ListIterator listIterator()
```
    Specified by:
    
    listIterator in interface List<Object>
  - parallelStream
```
public Stream<Object> parallelStream()
```
    Description copied from interface: ICollection
    
    Returns a parallel Stream using the elements of this enumerable.
    
    Specified by:
    
    parallelStream in interface ICollection<Object>
    
    Specified by:
    
    parallelStream in interface IEnumerable<Object>
    
    Specified by:
    
    parallelStream in interface Collection<Object>
    
    Returns:
    
    a parallel Stream using the elements of this enumerable.
  - peek
```
public final Object peek()
```
    Equivalent to First.
  - pop
```
public final Object pop()
```
    Removes the first element from this list and returns it.
  - popLast
```
public final Object popLast()
```
    Removes the last element from this list and returns it.
  - predCell
```
public final ListCell predCell(ListCell c)
```
    Returns the predecessor cell of the given list cell.
  - push
```
public final ListCell push(Object o)
```
    Equivalent to addFirst(Object).
  - remove
```
public final boolean remove(Object o)
```
    Removes the given object from this list.
    Only the first element for which equality to o holds gets removed.
    
    Specified by:
    
    remove in interface ICollection<Object>
    
    Specified by:
    
    remove in interface Collection<Object>
    
    Specified by:
    
    remove in interface List<Object>
    
    Complexity:
    O(size())
  - removeAll
```
public final boolean removeAll(Collection<? extends Object> collection)
```
    Removes the given collection of objects from this list.
    
    Specified by:
    
    removeAll in interface ICollection<Object>
    
    Specified by:
    
    removeAll in interface Collection<Object>
    
    Specified by:
    
    removeAll in interface List<Object>
    
    Returns:
    
    Whether there have been elements removed.
  - removeAt
```
public final Object removeAt(ICursor c)
```
    Removes the element pointed to by the given YCursor object.
    
    Precondition:
    The given cursor has been created by a call to this list's cursor() method and the element pointed to by it is contained in this list.
    
    Returns:
    
    The removed element.
  - removeCell
```
public final Object removeCell(ListCell c)
```
    Removes the given list cell, and hence the element stored in it, from this list.
    
    Precondition:
    The given list cell is part of this list.
    
    Complexity:
    O(1)
    
    Returns:
    
    The element that is stored in the removed cell.
  - retainAll
```
public final boolean retainAll(Collection<? extends Object> collection)
```
    Retains only those elements in this list which are contained in the given collection.
    
    Specified by:
    
    retainAll in interface ICollection<Object>
    
    Specified by:
    
    retainAll in interface Collection<Object>
    
    Specified by:
    
    retainAll in interface List<Object>
    
    Complexity:
    This operation has running time O(max(m, n)), were m and n are the sizes of this list and the given collection, respectively.
    
    Returns:
    
    Whether there have been elements removed.
  - reverse
```
public final void reverse()
```
    Reverses the sequence of elements in this list.
  - set
```
public final Object set(int index,
                        Object element)
```
    Specified by:
    
    set in interface List<Object>
  - setInfo
```
public final void setInfo(ListCell c,
                          Object value)
```
    Updates the element stored in the given list cell with the given object.
  - size
```
public final int size()
```
    Gets the number of elements in this list.
    
    Specified by:
    
    size in interface Collection<Object>
    
    Specified by:
    
    size in interface List<Object>
    
    Returns:
    
    The Count.
  - sort
```
public final void sort()
```
    Sorts the elements in this list into ascending order, according to their natural ordering.
    All elements must implement the Comparable interface. Furthermore, all elements in this list must be mutually comparable (that is, e1.compareTo(e2) must not throw a ClassCastException for any elements e1 and e2 in this list).
    
    NOTE: The elements will be assigned to different list cells by this method.
    
    Complexity:
    O(size() * log(size()))
  - sort
```
public final void sort(Comparator<Object> comp)
```
    Sorts the elements in this list according to the given comparator.
    NOTE: The elements will be assigned to different list cells by this method.
    
    Specified by:
    
    sort in interface List<Object>
    
    Complexity:
    O(size() * log(size()))
  - splice
```
public final void splice(YList list)
```
    Transfers the contents of the given list to the end of this list.
    The given list will be empty after this operation.
    
    Note that this operation transfers the list cells of the given list to this list. No new list cells are created by this operation.
    
    Complexity:
    O(1)
  - stream
```
public Stream<Object> stream()
```
    Description copied from interface: ICollection
    
    Returns a sequential Stream using the elements of this enumerable.
    
    Specified by:
    
    stream in interface ICollection<Object>
    
    Specified by:
    
    stream in interface IEnumerable<Object>
    
    Specified by:
    
    stream in interface Collection<Object>
    
    Returns:
    
    a sequential Stream using the elements of this enumerable.
  - subList
```
public final List<Object> subList(int fromIndex,
                                  int toIndex)
```
    Specified by:
    
    subList in interface List<Object>
  - succCell
```
public final ListCell succCell(ListCell c)
```
    Returns the successor cell of the given list cell.
  - toArray
```
public final Object[] toArray()
```
    Returns an array representation of this list.
    
    Specified by:
    
    toArray in interface ICollection<Object>
    
    Specified by:
    
    toArray in interface Collection<Object>
    
    Specified by:
    
    toArray in interface List<Object>
  - toArray
```
public Object[] toArray(Object[] a)
```
    Returns an array containing all list elements in the correct order.
    The runtime type of the returned array is that of the given array.
    
    If the list does not fit in the specified array, a new array is allocated with the runtime type of the specified array and the size of this list.
    
    If the list fits in the specified array with room to spare (i.e., the array has more elements than the list), the element in the array immediately following the end of the collection is set to null. This is useful in determining the length of the list only if the caller knows that the list does not contain any null elements.
    
    Specified by:
    
    toArray in interface ICollection<Object>
    
    Specified by:
    
    toArray in interface Collection<Object>
    
    Specified by:
    
    toArray in interface List<Object>
    
    Parameters:
    
    a - The array into which the elements of the list are to be stored, if it is big enough. Otherwise, a new array of the same runtime type is allocated for this purpose.
    
    Returns:
    
    An array containing the elements of the list. list.
  - toString
```
public String toString()
```
    Returns a string representation of this List.
    
    Overrides:
    
    toString in class Object

Class YList

Field Summary

Fields inherited from interface com.yworks.yfiles.utils.ICollection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Methods inherited from interface com.yworks.yfiles.utils.ICollection

Methods inherited from interface com.yworks.yfiles.utils.IEnumerable

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Constructor Detail

YList

YList

YList

YList

YList

YList

Method Detail

add

add

addAll

addAll

addAll

addFirst

addFirstCell

addLast

addLastCell

clear

contains

containsAll

copyTo

copyTo

cursor

cyclicPred

cyclicSucc

elementAt

enumerator

equals

findCell

first

firstCell

get

getCell

getInfo

hashCode

indexOf

insertAfter

insertBefore

insertCellAfter

insertCellBefore

isEmpty

last

lastCell

lastIndexOf

listIterator

parallelStream

peek

pop

popLast

predCell

push

remove

removeAll

removeAt

removeCell

retainAll

reverse

set

setInfo

size

sort

sort

splice

stream

subList

succCell

toArray

toArray

toString