IList

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractList<E>
  - - org.magicwerk.brownies.collections.IList<E>

Type Parameters:
E - type of elements stored in the list

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.Deque<E>, java.util.List<E>, java.util.Queue<E>, java.util.RandomAccess

Direct Known Subclasses:

BooleanObjGapList, ByteObjGapList, CharObjGapList, DoubleObjGapList, FloatObjGapList, GapList, IntObjGapList, LongObjGapList, ShortObjGapList
```
public abstract class IList<E>
extends java.util.AbstractList<E>
implements java.util.List<E>, java.util.RandomAccess, java.lang.Cloneable, java.io.Serializable, java.util.Deque<E>
```
GapList combines the strengths of both ArrayList and LinkedList. It is implemented to offer both efficient random access to elements by index (as ArrayList does) and at the same time efficient adding and removing elements to and from beginning and end (as LinkedList does). It also exploits the locality of reference often seen in applications to further improve performance, e.g. for iterating over the list.
Note that this implementation is not synchronized.

Version:

$Id: GapList.java 2098 2014-01-13 00:37:08Z origo $

Author:

Thomas Mauch

See Also:
List, ArrayList, LinkedList, Serialized Form

Constructor Summary

Constructors
Constructor and Description

IList()

Constructors
Constructor and Description
`IList()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`add(E elem)` Appends the specified element to the end of this list (optional operation).
`void`	`add(int index, E elem)` Inserts the specified element at the specified position in this list (optional operation).
`boolean`	`addAll(java.util.Collection<? extends E> coll)` Adds all of the elements in the specified collection into this list.
`boolean`	`addAll(E... elems)` Adds all specified elements into this list.
`boolean`	`addAll(IList<? extends E> list)` Adds all of the elements in the specified list into this list.
`boolean`	`addAll(int index, java.util.Collection<? extends E> coll)` Inserts all of the elements in the specified collection into this list, starting at the specified position.
`boolean`	`addAll(int index, E... elems)` Inserts the specified elements into this list, starting at the specified position.
`boolean`	`addAll(int index, IList<? extends E> list)` Inserts all of the elements in the specified list into this list, starting at the specified position.
`void`	`addFirst(E elem)` Inserts the specified element at the front of this deque if it is possible to do so immediately without violating capacity restrictions.
`boolean`	`addIfAbsent(E elem)` Add elements if it is not already contained in the list.
`void`	`addLast(E elem)` Inserts the specified element at the end of this deque if it is possible to do so immediately without violating capacity restrictions.
`abstract <K> int`	`binarySearch(int index, int len, K key, java.util.Comparator<? super K> comparator)` Searches the specified range for an object using the binary search algorithm.
`<K> int`	`binarySearch(K key, java.util.Comparator<? super K> comparator)` Searches the specified range for an object using the binary search algorithm.
`abstract int`	`capacity()` Returns capacity of this GapList.
`void`	`clear()` Removes all of the elements from this list (optional operation).
`java.lang.Object`	`clone()` Returns a shallow copy of this `GapList` instance (The elements themselves are not copied).
`boolean`	`contains(java.lang.Object elem)` Returns `true` if this collection contains the specified element.
`boolean`	`containsAll(java.util.Collection<?> coll)` Returns `true` if this collection contains all of the elements in the specified collection.
`boolean`	`containsAny(java.util.Collection<?> coll)` Returns true if any of the elements of the specified collection is contained in the list.
`IList<E>`	`copy()` Returns a shallow copy of this `GapList` instance (the new list will contain the same elements as the source list, i.e. the elements themselves are not copied).
`static <E> void`	`copy(IList<? extends E> src, int srcIndex, IList<E> dst, int dstIndex, int len)` Copies elements from one GapList to another.
`void`	`copy(int srcIndex, int dstIndex, int len)` Copy specified elements.
`java.util.Iterator<E>`	`descendingIterator()` Returns an iterator over the elements in this deque in reverse sequential order.
`void`	`drag(int srcIndex, int dstIndex, int len)` Drag specified elements.
`E`	`element()` Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque).
`void`	`ensureCapacity(int minCapacity)` Increases the capacity of this `GapList` instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.
`boolean`	`equals(java.lang.Object obj)` Compares the specified object with this list for equality.
`void`	`fill(E elem)` Fill list.
`void`	`fill(int index, int len, E elem)` Fill specified elements.
`void`	`filter(Predicate<? super E> predicate)` Filter the list using the specified predicate.
`E`	`get(int index)` Returns the element at the specified position in this list.
`IList<E>`	`getAll(E elem)` Returns all elements in the list equal to the specified element.
`IList<E>`	`getAll(int index, int len)` Returns specified range of elements from list.
`E[]`	`getArray(int index, int len)` Returns specified range of elements from list.
`int`	`getCount(E elem)` Counts how many times the specified element is contained in the list.
`java.util.Set<E>`	`getDistinct()` Returns distinct elements in the list.
`E`	`getFirst()` Retrieves, but does not remove, the first element of this deque.
`E`	`getLast()` Retrieves, but does not remove, the last element of this deque.
`int`	`hashCode()` Returns the hash code value for this list.
`int`	`indexOf(java.lang.Object elem)` Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
`void`	`init(int len, E elem)` Initializes the list so it will afterwards have a size of `len` and contain only the element `elem`.
`boolean`	`isEmpty()` Returns `true` if this collection contains no elements.
`java.util.Iterator<E>`	`iterator()` Returns an iterator over the elements in this list in proper sequence.
`int`	`lastIndexOf(java.lang.Object elem)` Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
`java.util.ListIterator<E>`	`listIterator()` Returns a list iterator over the elements in this list (in proper sequence).
`java.util.ListIterator<E>`	`listIterator(int index)` Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list.
`<R> IList<R>`	`mappedList(Mapper<E,R> mapper)` Create a new list by applying the specified mapper to all elements.
`static <E> void`	`move(IList<E> src, int srcIndex, IList<? super E> dst, int dstIndex, int len)` Moves elements from one GapList to another.
`void`	`move(int srcIndex, int dstIndex, int len)` Move specified elements.
`boolean`	`offer(E elem)` Inserts the specified element into the queue represented by this deque (in other words, at the tail of this deque) if it is possible to do so immediately without violating capacity restrictions, returning `true` upon success and `false` if no space is currently available.
`boolean`	`offerFirst(E elem)` Inserts the specified element at the front of this deque unless it would violate capacity restrictions.
`boolean`	`offerLast(E elem)` Inserts the specified element at the end of this deque unless it would violate capacity restrictions.
`E`	`peek()` Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque), or returns `null` if this deque is empty.
`E`	`peekFirst()` Retrieves, but does not remove, the first element of this deque, or returns `null` if this deque is empty.
`E`	`peekLast()` Retrieves, but does not remove, the last element of this deque, or returns `null` if this deque is empty.
`E`	`poll()` Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque), or returns `null` if this deque is empty.
`E`	`pollFirst()` Retrieves and removes the first element of this deque, or returns `null` if this deque is empty.
`E`	`pollLast()` Retrieves and removes the last element of this deque, or returns `null` if this deque is empty.
`E`	`pop()` Pops an element from the stack represented by this deque.
`void`	`push(E elem)` Pushes an element onto the stack represented by this deque (in other words, at the head of this deque) if it is possible to do so immediately without violating capacity restrictions, returning `true` upon success and throwing an `IllegalStateException` if no space is currently available.
`E`	`remove()` Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque).
`E`	`remove(int index)` Removes the element at the specified position in this list (optional operation).
`void`	`remove(int index, int len)` Remove specified range of elements from list.
`boolean`	`remove(java.lang.Object elem)` Removes a single instance of the specified element from this collection, if it is present (optional operation).
`boolean`	`removeAll(java.util.Collection<?> coll)` Removes all of this collection's elements that are also contained in the specified collection (optional operation).
`IList<E>`	`removeAll(E elem)` Removes all equal elements.
`boolean`	`removeAll(IList<?> coll)`
`E`	`removeFirst()` Retrieves and removes the first element of this deque.
`boolean`	`removeFirstOccurrence(java.lang.Object elem)` Removes the first occurrence of the specified element from this deque.
`E`	`removeLast()` Retrieves and removes the last element of this deque.
`boolean`	`removeLastOccurrence(java.lang.Object elem)` Removes the last occurrence of the specified element from this deque.
`void`	`resize(int len, E elem)` Resizes the list so it will afterwards have a size of `len`.
`boolean`	`retainAll(java.util.Collection<?> coll)` Retains only the elements in this collection that are contained in the specified collection (optional operation).
`boolean`	`retainAll(IList<?> coll)`
`void`	`reverse()` Reverses the order of all elements in the specified list.
`void`	`reverse(int index, int len)` Reverses the order of the specified elements in the list.
`void`	`rotate(int distance)` Rotate specified elements in the list.
`void`	`rotate(int index, int len, int distance)` Rotate specified elements in the list.
`E`	`set(int index, E elem)` Replaces the element at the specified position in this list with the specified element (optional operation).
`void`	`setAll(int index, java.util.Collection<? extends E> coll)` Replaces the specified elements.
`void`	`setAll(int index, E... elems)` Replaces the specified elements.
`void`	`setAll(int index, IList<? extends E> list)` Replaces the specified elements.
`abstract int`	`size()` Returns the number of elements in this collection.
`void`	`sort(java.util.Comparator<? super E> comparator)` Sort elements in the list using the specified comparator.
`abstract void`	`sort(int index, int len, java.util.Comparator<? super E> comparator)` Sort specified elements in the list using the specified comparator.
`static <E> void`	`swap(IList<E> src, int srcIndex, IList<E> dst, int dstIndex, int len)` Swaps elements from two GapLists.
`void`	`swap(int index1, int index2, int len)` Swap the specified elements in the list.
`java.lang.Object[]`	`toArray()` Returns an array containing all of the elements in this collection.
`java.lang.Object[]`	`toArray(int index, int len)` Returns an array containing the specified elements in this list.
`<T> T[]`	`toArray(T[] array)` Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.
`java.lang.String`	`toString()` Returns a string representation of this collection.
`abstract void`	`trimToSize()` Trims the capacity of this `GapList` instance to be the list's current size.
`abstract IList<E>`	`unmodifiableList()` Returns an unmodifiable view of this list.

Methods inherited from class java.util.AbstractList
subList

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

Methods inherited from interface java.util.List
subList

- Constructor Detail
  - IList
```
public IList()
```
- Method Detail
  - copy
```
public IList<E> copy()
```
    Returns a shallow copy of this GapList instance (the new list will contain the same elements as the source list, i.e. the elements themselves are not copied). This method is identical to clone() except that the result is casted to GapList.
    
    Returns:
    a clone of this instance
    See Also:
    clone()
  - unmodifiableList
```
public abstract IList<E> unmodifiableList()
```
    Returns an unmodifiable view of this list. This method allows modules to provide users with "read-only" access to internal lists. Query operations on the returned list "read through" to the specified list, and attempts to modify the returned list, whether direct or via its iterator, result in an UnsupportedOperationException.
    
    Returns:
    an unmodifiable view of the specified list
  - clone
```
public java.lang.Object clone()
```
    Returns a shallow copy of this GapList instance (The elements themselves are not copied). The capacity of the list will be set to the number of elements, so after calling clone(), size and capacity are equal.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    a clone of this GapList instance
    See Also:
    Cloneable
  - clear
```
public void clear()
```
    Description copied from class: java.util.AbstractList
    
    Removes all of the elements from this list (optional operation). The list will be empty after this call returns.
    This implementation calls removeRange(0, size()).
    Note that this implementation throws an UnsupportedOperationException unless remove(int index) or removeRange(int fromIndex, int toIndex) is overridden.
    
    Specified by:
    
    clear in interface java.util.Collection<E>
    
    Specified by:
    
    clear in interface java.util.List<E>
    
    Overrides:
    
    clear in class java.util.AbstractList<E>
  - size
```
public abstract int size()
```
    Description copied from interface: java.util.Collection
    
    Returns the number of elements in this collection. If this collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
    
    Specified by:
    
    size in interface java.util.Collection<E>
    
    Specified by:
    
    size in interface java.util.Deque<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 collection
  - capacity
```
public abstract int capacity()
```
    Returns capacity of this GapList. Note that two GapLists are considered equal even if they have a distinct capacity. Also the capacity can be changed by operations like clone() etc.
    
    Returns:
    capacity of this GapList
  - get
```
public E get(int index)
```
    Description copied from class: java.util.AbstractList
    
    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
  - set
```
public E set(int index,
    E elem)
```
    Description copied from class: java.util.AbstractList
    
    Replaces the element at the specified position in this list with the specified element (optional operation).
    This implementation always throws an UnsupportedOperationException.
    
    Specified by:
    
    set in interface java.util.List<E>
    
    Overrides:
    
    set in class java.util.AbstractList<E>
    
    Parameters:
    index - index of the element to replace
    elem - element to be stored at the specified position
    
    Returns:
    the element previously at the specified position
  - add
```
public boolean add(E elem)
```
    Description copied from class: java.util.AbstractList
    
    Appends the specified element to the end of this list (optional operation).
    Lists that support this operation may place limitations on what elements may be added to this list. In particular, some lists will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. List classes should clearly specify in their documentation any restrictions on what elements may be added.
    This implementation calls add(size(), e).
    Note that this implementation throws an UnsupportedOperationException unless add(int, E) is overridden.
    
    Specified by:
    
    add in interface java.util.Collection<E>
    
    Specified by:
    
    add in interface java.util.Deque<E>
    
    Specified by:
    
    add in interface java.util.List<E>
    
    Specified by:
    
    add in interface java.util.Queue<E>
    
    Overrides:
    
    add in class java.util.AbstractList<E>
    
    Parameters:
    elem - element to be appended to this list
    
    Returns:
    true (as specified by Collection.add(E))
  - add
```
public void add(int index,
       E elem)
```
    Description copied from class: java.util.AbstractList
    
    Inserts the specified element at the specified position in this list (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).
    This implementation always throws an UnsupportedOperationException.
    
    Specified by:
    
    add in interface java.util.List<E>
    
    Overrides:
    
    add in class java.util.AbstractList<E>
    
    Parameters:
    index - index at which the specified element is to be inserted
    elem - element to be inserted
  - remove
```
public E remove(int index)
```
    Description copied from class: java.util.AbstractList
    
    Removes the element at the specified position in this list (optional operation). Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.
    This implementation always throws an UnsupportedOperationException.
    
    Specified by:
    
    remove in interface java.util.List<E>
    
    Overrides:
    
    remove in class java.util.AbstractList<E>
    
    Parameters:
    index - the index of the element to be removed
    
    Returns:
    the element previously at the specified position
  - ensureCapacity
```
public void ensureCapacity(int minCapacity)
```
    Increases the capacity of this GapList instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.
    
    Parameters:
    minCapacity - the desired minimum capacity
  - trimToSize
```
public abstract void trimToSize()
```
    Trims the capacity of this GapList instance to be the list's current size. An application can use this operation to minimize the storage of an GapList instance.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Description copied from class: java.util.AbstractList
    
    Compares the specified object with this list for equality. Returns true if and only if the specified object is also a list, both lists have the same size, and all corresponding pairs of elements in the two lists are equal. (Two elements e1 and e2 are equal if (e1==null ? e2==null : e1.equals(e2)).) In other words, two lists are defined to be equal if they contain the same elements in the same order.
    This implementation first checks if the specified object is this list. If so, it returns true; if not, it checks if the specified object is a list. If not, it returns false; if so, it iterates over both lists, comparing corresponding pairs of elements. If any comparison returns false, this method returns false. If either iterator runs out of elements before the other it returns false (as the lists are of unequal length); otherwise it returns true when the iterations complete.
    
    Specified by:
    
    equals in interface java.util.Collection<E>
    
    Specified by:
    
    equals in interface java.util.List<E>
    
    Overrides:
    
    equals in class java.util.AbstractList<E>
    
    Parameters:
    obj - the object to be compared for equality with this list
    
    Returns:
    true if the specified object is equal to this list
    See Also:
    Object.hashCode(), Hashtable
  - hashCode
```
public int hashCode()
```
    Description copied from class: java.util.AbstractList
    
    Returns the hash code value for this list.
    This implementation uses exactly the code that is used to define the list hash function in the documentation for the List.hashCode() method.
    
    Specified by:
    
    hashCode in interface java.util.Collection<E>
    
    Specified by:
    
    hashCode in interface java.util.List<E>
    
    Overrides:
    
    hashCode in class java.util.AbstractList<E>
    
    Returns:
    the hash code value for this list
    See Also:
    Object.equals(java.lang.Object), Hashtable
  - toString
```
public java.lang.String toString()
```
    Description copied from class: java.util.AbstractCollection
    
    Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in square brackets ("[]"). Adjacent elements are separated by the characters ", " (comma and space). Elements are converted to strings as by String.valueOf(Object).
    
    Overrides:
    
    toString in class java.util.AbstractCollection<E>
    
    Returns:
    a string representation of this collection
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from class: java.util.AbstractCollection
    
    Returns true if this collection contains no elements.
    This implementation returns size() == 0.
    
    Specified by:
    
    isEmpty in interface java.util.Collection<E>
    
    Specified by:
    
    isEmpty in interface java.util.List<E>
    
    Overrides:
    
    isEmpty in class java.util.AbstractCollection<E>
    
    Returns:
    true if this collection contains no elements
  - getCount
```
public int getCount(E elem)
```
    Counts how many times the specified element is contained in the list.
    
    Parameters:
    elem - element to count
    
    Returns:
    count how many times the specified element is contained in the list
  - getAll
```
public IList<E> getAll(E elem)
```
    Returns all elements in the list equal to the specified element.
    
    Parameters:
    elem - element to look for
    
    Returns:
    all elements in the list equal to the specified element
  - getDistinct
```
public java.util.Set<E> getDistinct()
```
    Returns distinct elements in the list.
    
    Returns:
    distinct elements in the list
  - mappedList
```
public <R> IList<R> mappedList(Mapper<E,R> mapper)
```
    Create a new list by applying the specified mapper to all elements.
    
    Parameters:
    mapper - mapper function
    
    Returns:
    created list
  - filter
```
public void filter(Predicate<? super E> predicate)
```
    Filter the list using the specified predicate. Only element which are allowed remain in the list, the others are removed
    
    Parameters:
    predicate - predicate used for filtering
  - indexOf
```
public int indexOf(java.lang.Object elem)
```
    Description copied from class: java.util.AbstractList
    
    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 (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.
    This implementation first gets a list iterator (with listIterator()). Then, it iterates over the list until the specified element is found or the end of the list is reached.
    
    Specified by:
    
    indexOf in interface java.util.List<E>
    
    Overrides:
    
    indexOf in class java.util.AbstractList<E>
    
    Parameters:
    elem - element to search for
    
    Returns:
    the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element
  - lastIndexOf
```
public int lastIndexOf(java.lang.Object elem)
```
    Description copied from class: java.util.AbstractList
    
    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 (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.
    This implementation first gets a list iterator that points to the end of the list (with listIterator(size())). Then, it iterates backwards over the list until the specified element is found, or the beginning of the list is reached.
    
    Specified by:
    
    lastIndexOf in interface java.util.List<E>
    
    Overrides:
    
    lastIndexOf in class java.util.AbstractList<E>
    
    Parameters:
    elem - element to search for
    
    Returns:
    the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element
  - remove
```
public boolean remove(java.lang.Object elem)
```
    Description copied from class: java.util.AbstractCollection
    
    Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if this collection contains one or more such elements. Returns true if this collection contained the specified element (or equivalently, if this collection changed as a result of the call).
    This implementation iterates over the collection looking for the specified element. If it finds the element, it removes the element from the collection using the iterator's remove method.
    Note that this implementation throws an UnsupportedOperationException if the iterator returned by this collection's iterator method does not implement the remove method and this collection contains the specified object.
    
    Specified by:
    
    remove in interface java.util.Collection<E>
    
    Specified by:
    
    remove in interface java.util.Deque<E>
    
    Specified by:
    
    remove in interface java.util.List<E>
    
    Overrides:
    
    remove in class java.util.AbstractCollection<E>
    
    Parameters:
    elem - element to be removed from this collection, if present
    
    Returns:
    true if an element was removed as a result of this call
  - contains
```
public boolean contains(java.lang.Object elem)
```
    Description copied from class: java.util.AbstractCollection
    
    Returns true if this collection contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that (o==null ? e==null : o.equals(e)).
    This implementation iterates over the elements in the collection, checking each element in turn for equality with the specified element.
    
    Specified by:
    
    contains in interface java.util.Collection<E>
    
    Specified by:
    
    contains in interface java.util.Deque<E>
    
    Specified by:
    
    contains in interface java.util.List<E>
    
    Overrides:
    
    contains in class java.util.AbstractCollection<E>
    
    Parameters:
    elem - element whose presence in this collection is to be tested
    
    Returns:
    true if this collection contains the specified element
  - addIfAbsent
```
public boolean addIfAbsent(E elem)
```
    Add elements if it is not already contained in the list.
    
    Parameters:
    elem - element to add
    
    Returns:
    true if element has been added, false if not
  - containsAny
```
public boolean containsAny(java.util.Collection<?> coll)
```
    Returns true if any of the elements of the specified collection is contained in the list.
    
    Parameters:
    coll - collection with elements to be contained
    
    Returns:
    true if any element is contained, false otherwise
  - containsAll
```
public boolean containsAll(java.util.Collection<?> coll)
```
    Description copied from class: java.util.AbstractCollection
    
    Returns true if this collection contains all of the elements in the specified collection.
    This implementation iterates over the specified collection, checking each element returned by the iterator in turn to see if it's contained in this collection. If all elements are so contained true is returned, otherwise false.
    
    Specified by:
    
    containsAll in interface java.util.Collection<E>
    
    Specified by:
    
    containsAll in interface java.util.List<E>
    
    Overrides:
    
    containsAll in class java.util.AbstractCollection<E>
    
    Parameters:
    coll - collection to be checked for containment in this collection
    
    Returns:
    true if this collection contains all of the elements in the specified collection
    See Also:
    AbstractCollection.contains(Object)
  - removeAll
```
public boolean removeAll(java.util.Collection<?> coll)
```
    Description copied from class: java.util.AbstractCollection
    
    Removes all of this collection's elements that are also contained in the specified collection (optional operation). After this call returns, this collection will contain no elements in common with the specified collection.
    This implementation iterates over this collection, checking each element returned by the iterator in turn to see if it's contained in the specified collection. If it's so contained, it's removed from this collection with the iterator's remove method.
    Note that this implementation will throw an UnsupportedOperationException if the iterator returned by the iterator method does not implement the remove method and this collection contains one or more elements in common with the specified collection.
    
    Specified by:
    
    removeAll in interface java.util.Collection<E>
    
    Specified by:
    
    removeAll in interface java.util.List<E>
    
    Overrides:
    
    removeAll in class java.util.AbstractCollection<E>
    
    Parameters:
    coll - collection containing elements to be removed from this collection
    
    Returns:
    true if this collection changed as a result of the call
    See Also:
    AbstractCollection.remove(Object), AbstractCollection.contains(Object)
  - removeAll
```
public IList<E> removeAll(E elem)
```
    Removes all equal elements.
    
    Parameters:
    elem - element
    
    Returns:
    removed equal elements (never null)
  - removeAll
```
public boolean removeAll(IList<?> coll)
```
    See Also:
    removeAll(Collection)
  - retainAll
```
public boolean retainAll(java.util.Collection<?> coll)
```
    Description copied from class: java.util.AbstractCollection
    
    Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection.
    This implementation iterates over this collection, checking each element returned by the iterator in turn to see if it's contained in the specified collection. If it's not so contained, it's removed from this collection with the iterator's remove method.
    Note that this implementation will throw an UnsupportedOperationException if the iterator returned by the iterator method does not implement the remove method and this collection contains one or more elements not present in the specified collection.
    
    Specified by:
    
    retainAll in interface java.util.Collection<E>
    
    Specified by:
    
    retainAll in interface java.util.List<E>
    
    Overrides:
    
    retainAll in class java.util.AbstractCollection<E>
    
    Parameters:
    coll - collection containing elements to be retained in this collection
    
    Returns:
    true if this collection changed as a result of the call
    See Also:
    AbstractCollection.remove(Object), AbstractCollection.contains(Object)
  - retainAll
```
public boolean retainAll(IList<?> coll)
```
    See Also:
    retainAll(Collection)
  - toArray
```
public java.lang.Object[] toArray()
```
    Description copied from class: java.util.AbstractCollection
    Returns an array containing all of the elements in this collection. If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.
    The returned array will be "safe" in that no references to it are maintained by this collection. (In other words, this method must allocate a new array even if this collection is backed by an array). The caller is thus free to modify the returned array.
    This method acts as bridge between array-based and collection-based APIs.
    This implementation returns an array containing all the elements returned by this collection's iterator, in the same order, stored in consecutive elements of the array, starting with index 0. The length of the returned array is equal to the number of elements returned by the iterator, even if the size of this collection changes during iteration, as might happen if the collection permits concurrent modification during iteration. The size method is called only as an optimization hint; the correct result is returned even if the iterator returns a different number of elements.
    This method is equivalent to:
```
 List<E> list = new ArrayList<E>(size());
 for (E e : this)
     list.add(e);
 return list.toArray();
 
```
    Specified by:
    
    toArray in interface java.util.Collection<E>
    
    Specified by:
    
    toArray in interface java.util.List<E>
    
    Overrides:
    
    toArray in class java.util.AbstractCollection<E>
    
    Returns:
    an array containing all of the elements in this collection
    See Also:
    Arrays.asList(Object[])
  - toArray
```
public java.lang.Object[] toArray(int index,
                         int len)
```
    Returns an array containing the specified elements in this list.
    
    Parameters:
    index - index of first element to copy
    len - number of elements to copy
    
    Returns:
    array the specified elements
  - toArray
```
public <T> T[] toArray(T[] array)
```
    Description copied from class: java.util.AbstractCollection
    Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array. If the collection fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this collection.
    If this collection fits in the specified array with room to spare (i.e., the array has more elements than this collection), the element in the array immediately following the end of the collection is set to null. (This is useful in determining the length of this collection only if the caller knows that this collection does not contain any null elements.)
    If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.
    Like the Collection.toArray() method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs.
    Suppose x is a collection known to contain only strings. The following code can be used to dump the collection into a newly allocated array of String:
```
     String[] y = x.toArray(new String[0]);
```
    Note that toArray(new Object[0]) is identical in function to toArray().
    This implementation returns an array containing all the elements returned by this collection's iterator in the same order, stored in consecutive elements of the array, starting with index 0. If the number of elements returned by the iterator is too large to fit into the specified array, then the elements are returned in a newly allocated array with length equal to the number of elements returned by the iterator, even if the size of this collection changes during iteration, as might happen if the collection permits concurrent modification during iteration. The size method is called only as an optimization hint; the correct result is returned even if the iterator returns a different number of elements.
    This method is equivalent to:
```
 List<E> list = new ArrayList<E>(size());
 for (E e : this)
     list.add(e);
 return list.toArray(a);
 
```
    Specified by:
    
    toArray in interface java.util.Collection<E>
    
    Specified by:
    
    toArray in interface java.util.List<E>
    
    Overrides:
    
    toArray in class java.util.AbstractCollection<E>
    
    Parameters:
    array - the array into which the elements of this collection 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 all of the elements in this collection
  - addAll
```
public boolean addAll(java.util.Collection<? extends E> coll)
```
    Adds all of the elements in the specified collection into this list. The new elements will appear in the list in the order that they are returned by the specified collection's iterator.
    
    Specified by:
    
    addAll in interface java.util.Collection<E>
    
    Specified by:
    
    addAll in interface java.util.List<E>
    
    Overrides:
    
    addAll in class java.util.AbstractCollection<E>
    
    Parameters:
    coll - collection containing elements to be added to this list
    
    Returns:
    true if this list changed as a result of the call
    
    Throws:
    
    java.lang.NullPointerException - if the specified collection is null
    See Also:
    AbstractCollection.add(Object)
  - addAll
```
public boolean addAll(int index,
             java.util.Collection<? extends E> coll)
```
    Inserts all of the elements in the specified collection into this list, starting at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in the list in the order that they are returned by the specified collection's iterator.
    
    Specified by:
    
    addAll in interface java.util.List<E>
    
    Overrides:
    
    addAll in class java.util.AbstractList<E>
    
    Parameters:
    index - index at which to insert the first element from the specified collection
    coll - collection containing elements to be inserted into this list
    
    Returns:
    true if this list changed as a result of the call
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the index is invalid
    
    java.lang.NullPointerException - if the specified collection is null
  - addAll
```
public boolean addAll(E... elems)
```
    Adds all specified elements into this list.
    
    Parameters:
    elems - elements to be added to this list
    
    Returns:
    true if this list changed as a result of the call
  - addAll
```
public boolean addAll(int index,
             E... elems)
```
    Inserts the specified elements into this list, starting at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices).
    
    Parameters:
    index - index at which to insert the first element from the specified collection
    elems - elements to be inserted into this list
    
    Returns:
    true if this list changed as a result of the call
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the index is invalid
  - addAll
```
public boolean addAll(IList<? extends E> list)
```
    Adds all of the elements in the specified list into this list.
    
    Parameters:
    list - collection containing elements to be added to this list
    
    Returns:
    true if this list changed as a result of the call
    
    Throws:
    
    java.lang.NullPointerException - if the specified list is null
  - addAll
```
public boolean addAll(int index,
             IList<? extends E> list)
```
    Inserts all of the elements in the specified list into this list, starting at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices).
    
    Parameters:
    index - index at which to insert the first element from the specified collection
    list - list containing elements to be inserted into this list
    
    Returns:
    true if this list changed as a result of the call
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the index is invalid
    
    java.lang.NullPointerException - if the specified collection is null
  - iterator
```
public java.util.Iterator<E> iterator()
```
    Description copied from class: java.util.AbstractList
    
    Returns an iterator over the elements in this list in proper sequence.
    This implementation returns a straightforward implementation of the iterator interface, relying on the backing list's size(), get(int), and remove(int) methods.
    Note that the iterator returned by this method will throw an UnsupportedOperationException in response to its remove method unless the list's remove(int) method is overridden.
    This implementation can be made to throw runtime exceptions in the face of concurrent modification, as described in the specification for the (protected) modCount field.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<E>
    
    Specified by:
    
    iterator in interface java.util.Collection<E>
    
    Specified by:
    
    iterator in interface java.util.Deque<E>
    
    Specified by:
    
    iterator in interface java.util.List<E>
    
    Overrides:
    
    iterator in class java.util.AbstractList<E>
    
    Returns:
    an iterator over the elements in this list in proper sequence
    See Also:
    AbstractList.modCount
  - listIterator
```
public java.util.ListIterator<E> listIterator()
```
    Description copied from class: java.util.AbstractList
    
    Returns a list iterator over the elements in this list (in proper sequence).
    This implementation returns listIterator(0).
    
    Specified by:
    
    listIterator in interface java.util.List<E>
    
    Overrides:
    
    listIterator in class java.util.AbstractList<E>
    
    Returns:
    a list iterator over the elements in this list (in proper sequence)
    See Also:
    AbstractList.listIterator(int)
  - listIterator
```
public java.util.ListIterator<E> listIterator(int index)
```
    Description copied from class: java.util.AbstractList
    
    Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list. The specified index indicates the first element that would be returned by an initial call to next. An initial call to previous would return the element with the specified index minus one.
    This implementation returns a straightforward implementation of the ListIterator interface that extends the implementation of the Iterator interface returned by the iterator() method. The ListIterator implementation relies on the backing list's get(int), set(int, E), add(int, E) and remove(int) methods.
    Note that the list iterator returned by this implementation will throw an UnsupportedOperationException in response to its remove, set and add methods unless the list's remove(int), set(int, E), and add(int, E) methods are overridden.
    This implementation can be made to throw runtime exceptions in the face of concurrent modification, as described in the specification for the (protected) modCount field.
    
    Specified by:
    
    listIterator in interface java.util.List<E>
    
    Overrides:
    
    listIterator in class java.util.AbstractList<E>
    
    Parameters:
    index - index of first element to be returned from the list iterator (by a call to the next method)
    
    Returns:
    a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list
    See Also:
    AbstractList.modCount
  - descendingIterator
```
public java.util.Iterator<E> descendingIterator()
```
    Description copied from interface: java.util.Deque
    
    Returns an iterator over the elements in this deque in reverse sequential order. The elements will be returned in order from last (tail) to first (head).
    
    Specified by:
    
    descendingIterator in interface java.util.Deque<E>
    
    Returns:
    an iterator over the elements in this deque in reverse sequence
  - peek
```
public E peek()
```
    Description copied from interface: java.util.Deque
    
    Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque), or returns null if this deque is empty.
    This method is equivalent to Deque.peekFirst().
    
    Specified by:
    
    peek in interface java.util.Deque<E>
    
    Specified by:
    
    peek in interface java.util.Queue<E>
    
    Returns:
    the head of the queue represented by this deque, or null if this deque is empty
  - element
```
public E element()
```
    Description copied from interface: java.util.Deque
    
    Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque). This method differs from peek only in that it throws an exception if this deque is empty.
    This method is equivalent to Deque.getFirst().
    
    Specified by:
    
    element in interface java.util.Deque<E>
    
    Specified by:
    
    element in interface java.util.Queue<E>
    
    Returns:
    the head of the queue represented by this deque
  - poll
```
public E poll()
```
    Description copied from interface: java.util.Deque
    
    Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque), or returns null if this deque is empty.
    This method is equivalent to Deque.pollFirst().
    
    Specified by:
    
    poll in interface java.util.Deque<E>
    
    Specified by:
    
    poll in interface java.util.Queue<E>
    
    Returns:
    the first element of this deque, or null if this deque is empty
  - remove
```
public E remove()
```
    Description copied from interface: java.util.Deque
    
    Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque). This method differs from poll only in that it throws an exception if this deque is empty.
    This method is equivalent to Deque.removeFirst().
    
    Specified by:
    
    remove in interface java.util.Deque<E>
    
    Specified by:
    
    remove in interface java.util.Queue<E>
    
    Returns:
    the head of the queue represented by this deque
  - offer
```
public boolean offer(E elem)
```
    Description copied from interface: java.util.Deque
    
    Inserts the specified element into the queue represented by this deque (in other words, at the tail of this deque) if it is possible to do so immediately without violating capacity restrictions, returning true upon success and false if no space is currently available. When using a capacity-restricted deque, this method is generally preferable to the Deque.add(E) method, which can fail to insert an element only by throwing an exception.
    This method is equivalent to Deque.offerLast(E).
    
    Specified by:
    
    offer in interface java.util.Deque<E>
    
    Specified by:
    
    offer in interface java.util.Queue<E>
    
    Parameters:
    elem - the element to add
    
    Returns:
    true if the element was added to this deque, else false
  - getFirst
```
public E getFirst()
```
    Description copied from interface: java.util.Deque
    
    Retrieves, but does not remove, the first element of this deque. This method differs from peekFirst only in that it throws an exception if this deque is empty.
    
    Specified by:
    
    getFirst in interface java.util.Deque<E>
    
    Returns:
    the head of this deque
  - getLast
```
public E getLast()
```
    Description copied from interface: java.util.Deque
    
    Retrieves, but does not remove, the last element of this deque. This method differs from peekLast only in that it throws an exception if this deque is empty.
    
    Specified by:
    
    getLast in interface java.util.Deque<E>
    
    Returns:
    the tail of this deque
  - addFirst
```
public void addFirst(E elem)
```
    Description copied from interface: java.util.Deque
    
    Inserts the specified element at the front of this deque if it is possible to do so immediately without violating capacity restrictions. When using a capacity-restricted deque, it is generally preferable to use method Deque.offerFirst(E).
    
    Specified by:
    
    addFirst in interface java.util.Deque<E>
    
    Parameters:
    elem - the element to add
  - addLast
```
public void addLast(E elem)
```
    Description copied from interface: java.util.Deque
    
    Inserts the specified element at the end of this deque if it is possible to do so immediately without violating capacity restrictions. When using a capacity-restricted deque, it is generally preferable to use method Deque.offerLast(E).
    This method is equivalent to Deque.add(E).
    
    Specified by:
    
    addLast in interface java.util.Deque<E>
    
    Parameters:
    elem - the element to add
  - removeFirst
```
public E removeFirst()
```
    Description copied from interface: java.util.Deque
    
    Retrieves and removes the first element of this deque. This method differs from pollFirst only in that it throws an exception if this deque is empty.
    
    Specified by:
    
    removeFirst in interface java.util.Deque<E>
    
    Returns:
    the head of this deque
  - removeLast
```
public E removeLast()
```
    Description copied from interface: java.util.Deque
    
    Retrieves and removes the last element of this deque. This method differs from pollLast only in that it throws an exception if this deque is empty.
    
    Specified by:
    
    removeLast in interface java.util.Deque<E>
    
    Returns:
    the tail of this deque
  - offerFirst
```
public boolean offerFirst(E elem)
```
    Description copied from interface: java.util.Deque
    
    Inserts the specified element at the front of this deque unless it would violate capacity restrictions. When using a capacity-restricted deque, this method is generally preferable to the Deque.addFirst(E) method, which can fail to insert an element only by throwing an exception.
    
    Specified by:
    
    offerFirst in interface java.util.Deque<E>
    
    Parameters:
    elem - the element to add
    
    Returns:
    true if the element was added to this deque, else false
  - offerLast
```
public boolean offerLast(E elem)
```
    Description copied from interface: java.util.Deque
    
    Inserts the specified element at the end of this deque unless it would violate capacity restrictions. When using a capacity-restricted deque, this method is generally preferable to the Deque.addLast(E) method, which can fail to insert an element only by throwing an exception.
    
    Specified by:
    
    offerLast in interface java.util.Deque<E>
    
    Parameters:
    elem - the element to add
    
    Returns:
    true if the element was added to this deque, else false
  - peekFirst
```
public E peekFirst()
```
    Description copied from interface: java.util.Deque
    
    Retrieves, but does not remove, the first element of this deque, or returns null if this deque is empty.
    
    Specified by:
    
    peekFirst in interface java.util.Deque<E>
    
    Returns:
    the head of this deque, or null if this deque is empty
  - peekLast
```
public E peekLast()
```
    Description copied from interface: java.util.Deque
    
    Retrieves, but does not remove, the last element of this deque, or returns null if this deque is empty.
    
    Specified by:
    
    peekLast in interface java.util.Deque<E>
    
    Returns:
    the tail of this deque, or null if this deque is empty
  - pollFirst
```
public E pollFirst()
```
    Description copied from interface: java.util.Deque
    
    Retrieves and removes the first element of this deque, or returns null if this deque is empty.
    
    Specified by:
    
    pollFirst in interface java.util.Deque<E>
    
    Returns:
    the head of this deque, or null if this deque is empty
  - pollLast
```
public E pollLast()
```
    Description copied from interface: java.util.Deque
    
    Retrieves and removes the last element of this deque, or returns null if this deque is empty.
    
    Specified by:
    
    pollLast in interface java.util.Deque<E>
    
    Returns:
    the tail of this deque, or null if this deque is empty
  - pop
```
public E pop()
```
    Description copied from interface: java.util.Deque
    
    Pops an element from the stack represented by this deque. In other words, removes and returns the first element of this deque.
    This method is equivalent to Deque.removeFirst().
    
    Specified by:
    
    pop in interface java.util.Deque<E>
    
    Returns:
    the element at the front of this deque (which is the top of the stack represented by this deque)
  - push
```
public void push(E elem)
```
    Description copied from interface: java.util.Deque
    
    Pushes an element onto the stack represented by this deque (in other words, at the head of this deque) if it is possible to do so immediately without violating capacity restrictions, returning true upon success and throwing an IllegalStateException if no space is currently available.
    This method is equivalent to Deque.addFirst(E).
    
    Specified by:
    
    push in interface java.util.Deque<E>
    
    Parameters:
    elem - the element to push
  - removeFirstOccurrence
```
public boolean removeFirstOccurrence(java.lang.Object elem)
```
    Description copied from interface: java.util.Deque
    
    Removes the first occurrence of the specified element from this deque. If the deque does not contain the element, it is unchanged. More formally, removes the first element e such that (o==null ? e==null : o.equals(e)) (if such an element exists). Returns true if this deque contained the specified element (or equivalently, if this deque changed as a result of the call).
    
    Specified by:
    
    removeFirstOccurrence in interface java.util.Deque<E>
    
    Parameters:
    elem - element to be removed from this deque, if present
    
    Returns:
    true if an element was removed as a result of this call
  - removeLastOccurrence
```
public boolean removeLastOccurrence(java.lang.Object elem)
```
    Description copied from interface: java.util.Deque
    
    Removes the last occurrence of the specified element from this deque. If the deque does not contain the element, it is unchanged. More formally, removes the last element e such that (o==null ? e==null : o.equals(e)) (if such an element exists). Returns true if this deque contained the specified element (or equivalently, if this deque changed as a result of the call).
    
    Specified by:
    
    removeLastOccurrence in interface java.util.Deque<E>
    
    Parameters:
    elem - element to be removed from this deque, if present
    
    Returns:
    true if an element was removed as a result of this call
  - move
```
public static <E> void move(IList<E> src,
            int srcIndex,
            IList<? super E> dst,
            int dstIndex,
            int len)
```
    Moves elements from one GapList to another.
    
    Type Parameters:
    E - type of elements stored in the list
    Parameters:
    src - source list
    srcIndex - index of first element in source list
    dst - destination list
    dstIndex - index of first element in source list
    len - number of elements to move
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the ranges are invalid
  - copy
```
public static <E> void copy(IList<? extends E> src,
            int srcIndex,
            IList<E> dst,
            int dstIndex,
            int len)
```
    Copies elements from one GapList to another.
    
    Type Parameters:
    E - type of elements stored in the list
    Parameters:
    src - source list
    srcIndex - index of first element in source list
    dst - destination list
    dstIndex - index of first element in source list
    len - number of elements to copy
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the ranges are invalid
  - swap
```
public static <E> void swap(IList<E> src,
            int srcIndex,
            IList<E> dst,
            int dstIndex,
            int len)
```
    Swaps elements from two GapLists.
    
    Type Parameters:
    E - type of elements stored in the list
    Parameters:
    src - first list
    srcIndex - index of first element in first list
    dst - second list
    dstIndex - index of first element in second list
    len - number of elements to swap
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the ranges are invalid
  - getAll
```
public IList<E> getAll(int index,
              int len)
```
    Returns specified range of elements from list.
    
    Parameters:
    index - index of first element to retrieve
    len - number of elements to retrieve
    
    Returns:
    GapList containing the specified range of elements from list
  - getArray
```
public E[] getArray(int index,
           int len)
```
    Returns specified range of elements from list.
    
    Parameters:
    index - index of first element to retrieve
    len - number of elements to retrieve
    
    Returns:
    GapList containing the specified range of elements from list
  - setAll
```
public void setAll(int index,
          IList<? extends E> list)
```
    Replaces the specified elements.
    
    Parameters:
    index - index of first element to set
    list - list with elements to set
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the range is invalid
  - setAll
```
public void setAll(int index,
          java.util.Collection<? extends E> coll)
```
    Replaces the specified elements.
    
    Parameters:
    index - index of first element to set
    coll - collection with elements to set
  - setAll
```
public void setAll(int index,
          E... elems)
```
    Replaces the specified elements.
    
    Parameters:
    index - index of first element to set
    elems - elements to set
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the range is invalid
  - remove
```
public void remove(int index,
          int len)
```
    Remove specified range of elements from list.
    
    Parameters:
    index - index of first element to remove
    len - number of elements to remove
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the range is invalid
  - init
```
public void init(int len,
        E elem)
```
    Initializes the list so it will afterwards have a size of len and contain only the element elem. The list will grow or shrink as needed.
    
    Parameters:
    len - length of list
    elem - element which the list will contain
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the range is invalid
  - resize
```
public void resize(int len,
          E elem)
```
    Resizes the list so it will afterwards have a size of len. If the list must grow, the specified element elem will be used for filling.
    
    Parameters:
    len - length of list
    elem - element which will be used for extending the list
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the range is invalid
  - fill
```
public void fill(E elem)
```
    Fill list.
    
    Parameters:
    elem - element used for filling
  - fill
```
public void fill(int index,
        int len,
        E elem)
```
    Fill specified elements.
    
    Parameters:
    index - index of first element to fill
    len - number of elements to fill
    elem - element used for filling
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the range is invalid
  - copy
```
public void copy(int srcIndex,
        int dstIndex,
        int len)
```
    Copy specified elements. Source and destination ranges may overlap. The size of the list does not change.
    
    Parameters:
    srcIndex - index of first source element to copy
    dstIndex - index of first destination element to copy
    len - number of elements to copy
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the ranges are invalid
  - move
```
public void move(int srcIndex,
        int dstIndex,
        int len)
```
    Move specified elements. Source and destination ranges may overlap. The elements which are moved away are set to null, so the size of the list does not change.
    
    Parameters:
    srcIndex - index of first source element to move
    dstIndex - index of first destination element to move
    len - number of elements to move
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the ranges are invalid
  - drag
```
public void drag(int srcIndex,
        int dstIndex,
        int len)
```
    Drag specified elements. Source and destination ranges may overlap. The size of the list does not change and it contains the same elements as before, but in changed order.
    
    Parameters:
    srcIndex - index of first source element to move
    dstIndex - index of first destination element to move
    len - number of elements to move
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the ranges are invalid
  - reverse
```
public void reverse()
```
    Reverses the order of all elements in the specified list.
  - reverse
```
public void reverse(int index,
           int len)
```
    Reverses the order of the specified elements in the list.
    
    Parameters:
    index - index of first element to reverse
    len - number of elements to reverse
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the ranges are invalid
  - swap
```
public void swap(int index1,
        int index2,
        int len)
```
    Swap the specified elements in the list.
    
    Parameters:
    index1 - index of first element in first range to swap
    index2 - index of first element in second range to swap
    len - number of elements to swap
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the ranges are invalid
  - rotate
```
public void rotate(int distance)
```
    Rotate specified elements in the list. The distance argument can be positive or negative: If it is positive, the elements are moved towards the end, if negative, the elements are moved toward the beginning, if distance is 0, the list is not changed.
    
    Parameters:
    distance - distance to move the elements
  - rotate
```
public void rotate(int index,
          int len,
          int distance)
```
    Rotate specified elements in the list. The distance argument can be positive or negative: If it is positive, the elements are moved towards the end, if negative, the elements are moved toward the beginning, if distance is 0, the list is not changed.
    
    Parameters:
    index - index of first element to rotate
    len - number of elements to rotate
    distance - distance to move the elements
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the ranges are invalid
  - sort
```
public void sort(java.util.Comparator<? super E> comparator)
```
    Sort elements in the list using the specified comparator.
    
    Parameters:
    comparator - comparator to use for sorting (null means the elements natural ordering should be used)
    See Also:
    Arrays.sort(long[])
  - sort
```
public abstract void sort(int index,
        int len,
        java.util.Comparator<? super E> comparator)
```
    Sort specified elements in the list using the specified comparator.
    
    Parameters:
    index - index of first element to sort
    len - number of elements to sort
    comparator - comparator to use for sorting (null means the elements natural ordering should be used)
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the range is invalid
    See Also:
    Arrays.sort(long[])
  - binarySearch
```
public <K> int binarySearch(K key,
                   java.util.Comparator<? super K> comparator)
```
    Searches the specified range for an object using the binary search algorithm.
    
    Parameters:
    key - the value to be searched for
    comparator - the comparator by which the list is ordered. A null value indicates that the elements' natural ordering should be used.
    
    Returns:
    index of the search key, if it is contained in the array; otherwise, (-(insertion point) - 1). The insertion point is defined as the point at which the key would be inserted into the array: the index of the first element greater than the key, or a.length if all elements in the array are less than the specified key. Note that this guarantees that the return value will be >= 0 if and only if the key is found.
    See Also:
    Arrays.binarySearch(long[], long)
  - binarySearch
```
public abstract <K> int binarySearch(int index,
                   int len,
                   K key,
                   java.util.Comparator<? super K> comparator)
```
    Searches the specified range for an object using the binary search algorithm.
    
    Parameters:
    index - index of first element to search
    len - number of elements to search
    key - the value to be searched for
    comparator - the comparator by which the list is ordered. A null value indicates that the elements' natural ordering should be used.
    
    Returns:
    index of the search key, if it is contained in the array; otherwise, (-(insertion point) - 1). The insertion point is defined as the point at which the key would be inserted into the array: the index of the first element greater than the key, or a.length if all elements in the array are less than the specified key. Note that this guarantees that the return value will be >= 0 if and only if the key is found.
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the range is invalid
    See Also:
    Arrays.binarySearch(long[], long)

Class IList<E>

Constructor Summary

Method Summary

Methods inherited from class java.util.AbstractList

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Constructor Detail

IList

Method Detail

copy

unmodifiableList

clone

clear

size

capacity

get

set

add

add

remove

ensureCapacity

trimToSize

equals

hashCode

toString

isEmpty

getCount

getAll

getDistinct

mappedList

filter

indexOf

lastIndexOf

remove

contains

addIfAbsent

containsAny

containsAll

removeAll

removeAll

removeAll

retainAll

retainAll

toArray

toArray

toArray

addAll

addAll

addAll

addAll

addAll

addAll

iterator

listIterator

listIterator

descendingIterator

peek

element

poll

remove

offer

getFirst

getLast

addFirst

addLast

removeFirst

removeLast

offerFirst

offerLast

peekFirst

peekLast

pollFirst

pollLast

pop

push

removeFirstOccurrence

removeLastOccurrence

move

copy

swap