java.lang.Object
org.magicwerk.brownies.collections.primitive.IIntList
Record Components:
type - of elements stored in the list
All Implemented Interfaces:
Serializable, Cloneable, IIntListable
Direct Known Subclasses:
IntBigList, IntGapList

public abstract class IIntList extends Object implements IIntListable, Cloneable, Serializable
Class IIntList is the abstract class which offers all interfaces implemented by ArrayList. It also offers additional methods which are then available in all implementations of GapList and
invalid reference
BigList
.
See Also:
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    protected static class 
    Wrapper to treat an array as IIntListable.
    protected static class 
    Wrapper to treat a Collection as IIntListable.
    protected static class 
    Wrapper to treat a List as IIntListable.
    protected static class 
    Wrapper to treat a repeated element as IIntListable.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private static final int
     
    private static final int
     
    private static final int
     
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    add(int elem)
     
    void
    add(int index, int elem)
    Inserts the specified element at the specified position in this list.
    boolean
    addAll(int index, Collection<Integer> coll)
    Inserts all of the elements in the specified collection into this list, starting at the specified position.
    boolean
    addAll(int index, IIntList list)
    Inserts all of the elements in the specified list into this list, starting at the specified position.
    boolean
    Adds all of the elements in the specified collection into this list.
    boolean
    Adds all of the elements in the specified list into this list.
    boolean
    addArray(int... elems)
    Adds all specified elements into this list.
    boolean
    addArray(int[] elems, int offset, int length)
     
    boolean
    addArray(int index, int... elems)
    Inserts the specified elements into this list, starting at the specified position.
    boolean
    addArray(int index, int[] elems, int offset, int length)
     
    void
    addFirst(int elem)
    boolean
    addIfAbsent(int elem)
     
    void
    addLast(int elem)
    boolean
    addMult(int len, int elem)
    Adds element multiple time to list.
    boolean
    addMult(int index, int len, int elem)
    Inserts element multiple time to list, starting at the specified position.
    protected IIntListable
    Return correct IIntListable for passed collection.
    int
    binarySearch(int key)
    Searches the specified range for an object using the binary* search algorithm.
    abstract int
    binarySearch(int index, int len, int key)
    Searches the specified range for an object using the binary search algorithm.
    abstract int
    Returns capacity of this list.
    protected void
    checkIndex(int index)
    Check that specified index is valid for getting/setting elements.
    protected void
    checkIndexAdd(int index)
    Check that specified index is valid for adding elements.
    protected void
    checkLength(int len)
    Check that specified length is valid (>= 0).
    protected void
    checkLengths(int len1, int len2)
    Check that both specified lengths are valid (>= 0) and equal.
    protected void
    Check that object is not null.
    protected void
    checkRange(int index, int len)
    Check that specified range is valid.
    void
     
    Returns a shallow copy of this list.
    boolean
    contains(int elem)
     
    boolean
     
    boolean
    Returns true if any of the elements of the specified collection is contained in the list.
    boolean
    Determines whether the list contains a matching element.
    abstract IIntList
    Returns a shallow copy of this list.
    void
    copy(int srcIndex, int dstIndex, int len)
    Copy specified elements.
    int
    count(int elem)
     
    int
     
    Returns a copy this list but without elements.
    protected abstract boolean
    doAdd(int index, int elem)
    Helper method for adding an element to the list.
    protected boolean
    doAddAll(int index, IIntListable list)
    Helper method for adding multiple elements to the list.
    protected abstract void
    Assign this list the content of the that list.
    protected void
     
    protected abstract void
    Initialize this object after the bitwise copy has been made by Object.clone().
    protected abstract IIntList
    doCreate(int capacity)
    Create list with specified capacity.
    protected int[]
    doCreateArray(Class clazz, int len)
    Create array.
    protected abstract void
    doEnsureCapacity(int minCapacity)
    Increases the capacity of this list instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.
    protected abstract int
    doGet(int index)
    Helper method for getting an element from the list.
    protected void
    doGetAll(int[] array, int index, int len)
    Helper method to fill the specified elements in an array.
    protected int
    doIndexOf(int elem, int fromIndex)
    Returns the index of the first occurrence of the specified element in this list, starting the search at the specified position.
    protected int
    doIndexOfIf(Predicate<Integer> predicate, int fromIndex)
    Returns the index of the first element which matches the specified predicate in this list, starting the search at the specified position.
    protected void
     
    protected int
    doLastIndexOf(int elem, int fromIndex)
    Returns the index of the last occurrence of the specified element in this list, starting the search at the specified position.
    protected int
    doLastIndexOfIf(Predicate<Integer> predicate, int fromIndex)
    Returns the index of the last occurrence of the specified element in this list, starting the search at the specified position.
    protected void
    This method is called internally before elements are allocated or freed.
    protected void
    doPutAll(int index, IIntListable list)
     
    protected abstract int
    doRemove(int index)
    Helper method to remove an element.
    protected void
    doRemoveAll(int index, int len)
    Remove specified range of elements from list.
    protected boolean
    doReplace(int index, int len, IIntListable list)
     
    protected abstract int
    doReSet(int index, int elem)
    Sets an element at specified position.
    protected void
    doRotate(int index, int len, int distance)
    Internal method to rotate specified elements in the list.
    protected abstract int
    doSet(int index, int elem)
    Helper method for setting an element in the list.
    (package private) void
    doTransfer(int transferMode, int srcIndex, int srcLen, IIntList dst, int dstIndex, int dstLen)
     
    (package private) void
    doTransferSwap(int srcIndex, IIntList dst, int dstIndex, int len)
     
    void
    drag(int srcIndex, int dstIndex, int len)
    Drag specified elements.
    int
    void
    ensureCapacity(int minCapacity)
     
    boolean
     
    (package private) static boolean
    equalsElem(int elem1, int elem2)
    Helper function to check two elements stored in the list for equality.
    extract(int index, int len)
    Removes specified range of elements from list and return them.
    Removes and returns all elements in the list which match the predicate.
    void
    fill(int elem)
     
    filter(Predicate<Integer> predicate)
    Create a new list by applying the specified filter to all elements.
    <R> IList<R>
     
    <R, C extends Collection<R>>
    IList<R>
     
    int
    get(int index)
     
    getAll(int elem)
    Returns all elements in the list equal to the specified element.
    getAll(int index, int len)
    Returns specified range of elements from list.
    protected abstract int
     
    Returns distinct elements in the list.
    int
     
    int
     
    int
    getIf(Predicate<Integer> predicate)
    Get first element in the list which matches the predicate.
    int
    int
    Returns the last element stored in the list.
    int
     
    int
     
    int
     
    (package private) static int
    hashCodeElem(int elem)
    Helper method to calculate hash code of a element stored in the list.
    abstract IIntList
    Returns an immutable copy of this list.
    int
    indexOf(int elem)
     
    int
    indexOf(int elem, int fromIndex)
    Returns the index of the first occurrence of the specified element in this list, starting the search at the specified position.
    int
    Returns the index of the first element which matches the specified predicate in this list.
    int
    indexOfIf(Predicate<Integer> predicate, int fromIndex)
    Returns the index of the first element which matches the specified predicate in this list, starting the search at the specified position.
    void
    Initializes the list so it will afterwards only contain the elements of the collection.
    void
    Initializes the list so it will afterwards only contain the elements of the collection.
    void
    initArray(int... elems)
    Initializes the list so it will afterwards only contain the elements of the array.
    void
    initMult(int len, int elem)
    Initializes the list so it will afterwards have a size of len and contain only the element elem.
    boolean
     
    abstract boolean
    Returns true if this list is either unmodifiable or immutable, false otherwise.
    int
    lastIndexOf(int elem)
     
    int
    lastIndexOf(int elem, int fromIndex)
    Returns the index of the last occurrence of the specified element in this list, starting the search at the specified position.
    int
    Returns the index of the last element which matches the specified predicate in this list.
    int
    lastIndexOfIf(Predicate<Integer> predicate, int fromIndex)
    Returns the index of the last occurrence of the specified element in this list, starting the search at the specified position.
    <R> IList<R>
    map(Function<Integer,R> func)
     
    <R> IList<R>
    mapFilter(Function<Integer,R> func, Predicate<R> filter)
     
    void
    move(int srcIndex, int dstIndex, int len)
    Move specified elements.
    boolean
    offer(int elem)
    boolean
    offerFirst(int elem)
    boolean
    offerLast(int elem)
    int
    int
    int
    int
    int
    int
    int
    pop()
    void
    push(int elem)
    int
    put(int index, int elem)
    Sets or adds the element.
    void
    putAll(int index, Collection<Integer> coll)
    Set or add the specified elements.
    void
    putAll(int index, IIntList list)
    Set or add the specified elements.
    void
    putArray(int index, int... elems)
    Set or add the specified elements.
    void
    putMult(int index, int len, int elem)
    Set or add the specified element multiple times.
    int
    int
    remove(int index)
     
    void
    remove(int index, int len)
    Remove specified range of elements from list.
    removeAll(int elem)
    Removes all equal elements.
    boolean
     
    boolean
     
    boolean
    removeElem(int elem)
     
    int
    boolean
    boolean
    Removes all elements in the list which match the predicate.
    int
    boolean
    protected void
    replace(int index, int len, IIntListable list)
     
    void
    replaceAll(int index, int len, Collection<Integer> coll)
    Replaces the specified range with new elements.
    void
    replaceAll(int index, int len, IIntList list)
    Replaces the specified range with new elements.
    void
    replaceArray(int index, int len, int... elems)
    Replaces the specified range with new elements.
    void
    replaceMult(int index, int len, int numElems, int elem)
    Replaces the specified range with new elements.
    void
    resize(int len, int elem)
    Resizes the list so it will afterwards have a size of len.
    void
    retain(int index, int len)
    Retain specified range of elements from list, the other elements are removed.
    boolean
     
    boolean
     
    boolean
    Retains all elements in the list which match the predicate.
    void
    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.
    int
    set(int index, int elem)
     
    void
    setAll(int index, Collection<Integer> coll)
    Sets the specified elements.
    void
    setAll(int index, IIntList list)
    Sets the specified elements.
    void
    setArray(int index, int... elems)
    Sets the specified elements.
    void
    setArray(int index, int[] elems, int offset, int length)
     
    void
    setMult(int index, int len, int elem)
    Sets the element multiple times.
    abstract int
     
    void
    Sort elements in the list using the specified comparator.
    abstract void
    sort(int index, int len)
    Sort specified elements in the list using the specified comparator.
    void
    swap(int index1, int index2, int len)
    Swap the specified elements in the list.
    int[]
     
    int[]
    toArray(int[] array)
     
    int[]
    toArray(int[] array, int index, int len)
    Returns an array containing the specified elements in this list.
    int[]
    toArray(int index, int len)
    Returns an array containing the specified elements in this list.
    int[]
    toArray(Class clazz)
    Returns an array containing the elements in this list.
    int[]
    toArray(Class clazz, int index, int len)
    Returns an array containing the specified elements in this list.
    (package private) static int[]
    Copies the collection values into an array.
     
    static void
    transferCopy(IIntList src, int srcIndex, int srcLen, IIntList dst, int dstIndex, int dstLen)
    Copies elements from one list to another.
    static void
    transferMove(IIntList src, int srcIndex, int srcLen, IIntList dst, int dstIndex, int dstLen)
    Moves elements from one list to another by setting it to null in the source list.
    static void
    transferRemove(IIntList src, int srcIndex, int srcLen, IIntList dst, int dstIndex, int dstLen)
    Moves elements from one list to another by removing it from the source list.
    static void
    transferSwap(IIntList src, int srcIndex, IIntList dst, int dstIndex, int len)
    Swaps elements from two lists.
    void
    Change the list by applying the specified operator to all elements.
    Create a new list by applying the specified transforming operator to all elements.
    abstract void
     
    abstract IIntList
     

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

  • Constructor Details

    • IIntList

      public IIntList()
  • Method Details

    • toArray

      static int[] toArray(Collection<Integer> coll)
      Copies the collection values into an array.
      Parameters:
      coll - collection of values
      Returns:
      array containing the collection values
    • copy

      public abstract IIntList copy()
      Returns a shallow copy of this list. The new list will contain the same elements as the source list, i.e. the elements themselves are not copied. The capacity of the list will be set to the number of elements, i.e. size and capacity are equal. This returned list will be modifiable, i.e. a read-only list will be copied and be modifiable again.
      Returns:
      a modifiable copy of this list
    • clone

      public IIntList clone()
      Returns a shallow copy of this list. The new list will contain the same elements as the source list, i.e. the elements themselves are not copied. The capacity of the list will be set to the number of elements, i.e. size and capacity are equal. If the list is read-only, the same list is returned without change. Use copy() to .
      Overrides:
      clone in class Object
      Returns:
      a modifiable copy of this list
    • crop

      public IIntList crop()
      Returns a copy this list but without elements. The new list will have the same type as this list.
      Returns:
      an empty copy of this list
    • isReadOnly

      public abstract boolean isReadOnly()
      Returns true if this list is either unmodifiable or immutable, false otherwise.
    • unmodifiableList

      public abstract IIntList unmodifiableList()
    • immutableList

      public abstract IIntList immutableList()
      Returns an immutable copy of this list. The returned list is independent from the original list, i.e. changes done later are not seen. Attempts to modify the returned list, whether direct or via its iterator, result in an UnsupportedOperationException. If this list is already immutable, it is returned unchanged. See unmodifiableList() to get unmodifiable view of a list.
      Returns:
      an immutable copy of the specified list
    • doClone

      protected abstract void doClone(IIntList that)
      Initialize this object after the bitwise copy has been made by Object.clone().
      Parameters:
      that - source object
    • clear

      public void clear()
    • doClear

      protected void doClear()
    • resize

      public void resize(int len, int 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 - new size of list
      elem - element which will be used for extending the list
      Throws:
      IndexOutOfBoundsException - if the range is invalid
    • size

      public abstract int size()
      Specified by:
      size in interface IIntListable
    • capacity

      public abstract int capacity()
      Returns capacity of this list. Note that two lists 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 list
    • get

      public int get(int index)
      Specified by:
      get in interface IIntListable
    • doGet

      protected abstract int doGet(int index)
      Helper method for getting an element from the list. This is the only method which really gets an element. Override if you need to validity checks before getting.
      Parameters:
      index - index of element to return
      Returns:
      the element at the specified position in this list
    • doSet

      protected abstract int doSet(int index, int elem)
      Helper method for setting an element in the list. This is the only method which really sets an element. Override if you need to validity checks before setting.
      Parameters:
      index - index where element will be placed
      elem - element to set
      Returns:
      old element which was at the position
    • set

      public int set(int index, int elem)
    • put

      public int put(int index, int elem)
      Sets or adds the element. If the index is smaller than the size of the list, the existing element is replaced. If the index equals the size of the list, the element is added.
      Parameters:
      index - index where element will be placed
      elem - element to put
      Returns:
      old element if an element was replaced, null if the element was added
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size())
    • doReSet

      protected abstract int doReSet(int index, int elem)
      Sets an element at specified position. This method is used internally if existing elements will be moved etc. Override if you need to validity checks.
      Parameters:
      index - index where element will be placed
      elem - element to set
      Returns:
      old element which was at the position
    • getDefaultElem

      protected abstract int getDefaultElem()
    • doModify

      protected void doModify()
      This method is called internally before elements are allocated or freed. Override if you need to validity checks.
    • add

      public boolean add(int elem)
    • add

      public void add(int index, int elem)
      Inserts the specified element at the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).
      Parameters:
      index - index at which the specified element is to be inserted
      elem - element to be inserted
    • doAdd

      protected abstract boolean doAdd(int index, int elem)
      Helper method for adding an element to the list. This is the only method which really adds an element. Override if you need to validity checks before adding.
      Parameters:
      index - index where element should be added (-1 means it is up to the implementation to choose the index)
      elem - element to add
      Returns:
      true if element has been added, false otherwise
    • remove

      public int remove(int index)
    • doRemove

      protected abstract int doRemove(int index)
      Helper method to remove an element. This is the only method which really removes an element. Override if you need to validity checks before removing.
      Parameters:
      index - index of element to remove
      Returns:
      removed element
    • ensureCapacity

      public void ensureCapacity(int minCapacity)
    • doEnsureCapacity

      protected abstract void doEnsureCapacity(int minCapacity)
      Increases the capacity of this list 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()
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • isEmpty

      public boolean isEmpty()
    • equalsElem

      static boolean equalsElem(int elem1, int elem2)
      Helper function to check two elements stored in the list for equality.
      Parameters:
      elem1 - first element
      elem2 - second element
      Returns:
      true if the elements are equal, otherwise false
    • hashCodeElem

      static int hashCodeElem(int elem)
      Helper method to calculate hash code of a element stored in the list.
      Parameters:
      elem - element
      Returns:
      hash code for element
    • count

      public int count(int elem)
    • countIf

      public int countIf(Predicate<Integer> predicate)
    • getSingle

      public int getSingle()
    • getSingleOrNull

      public int getSingleOrNull()
    • getAll

      public IIntList getAll(int 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
    • getIf

      public int getIf(Predicate<Integer> predicate)
      Get first element in the list which matches the predicate.
      Parameters:
      predicate - a predicate which returns true for elements to be selected
      Returns:
      first element matching the predicate, null otherwise
    • getDistinct

      public Set<Integer> getDistinct()
      Returns distinct elements in the list.
      Returns:
      distinct elements in the list
    • map

      public <R> IList<R> map(Function<Integer,R> func)
    • flatMap

      public <R, C extends Collection<R>> IList<R> flatMap(Function<Integer,C> func)
    • mapFilter

      public <R> IList<R> mapFilter(Function<Integer,R> func, Predicate<R> filter)
    • filterMap

      public <R> IList<R> filterMap(Predicate<Integer> filter, Function<Integer,R> func)
    • transformedList

      public IIntList transformedList(UnaryOperator<Integer> op)
      Create a new list by applying the specified transforming operator to all elements.
      Parameters:
      op - transforming operator
      Returns:
      created list
    • transform

      public void transform(UnaryOperator<Integer> op)
      Change the list by applying the specified operator to all elements.
      Parameters:
      op - transforming operator
    • filter

      public IIntList filter(Predicate<Integer> predicate)
      Create a new list by applying the specified filter to all elements. Only element which are allowed by the predicate are copied to the new list.
      Parameters:
      predicate - predicate used for filtering
      Returns:
      created list
    • retainIf

      public boolean retainIf(Predicate<Integer> predicate)
      Retains all elements in the list which match the predicate.
      Parameters:
      predicate - a predicate which returns true for elements to be retained
      Returns:
      true if the list was changed
    • removeIf

      public boolean removeIf(Predicate<Integer> predicate)
      Removes all elements in the list which match the predicate.
      Parameters:
      predicate - a predicate which returns true for elements to be removed
      Returns:
      true if the list was changed
    • extractIf

      public IIntList extractIf(Predicate<Integer> predicate)
      Removes and returns all elements in the list which match the predicate.
      Parameters:
      predicate - predicate
      Returns:
      elements which have been removed from the list
    • indexOf

      public int indexOf(int elem)
    • indexOf

      public int indexOf(int elem, int fromIndex)
      Returns the index of the first occurrence of the specified element in this list, starting the search at the specified position. If the element is not found, -1 is returned.
      Parameters:
      elem - element to search for
      fromIndex - start index for search
      Returns:
      the index of the first occurrence of the specified element in this list that is greater than or equal to fromIndex, or -1 if this list does not contain the element
      See Also:
      • invalid reference
        #indexOf(Object)
    • doIndexOf

      protected int doIndexOf(int elem, int fromIndex)
      Returns the index of the first occurrence of the specified element in this list, starting the search at the specified position. If the element is not found, -1 is returned.
    • indexOfIf

      public int indexOfIf(Predicate<Integer> predicate)
      Returns the index of the first element which matches the specified predicate in this list. If no such element is not found, -1 is returned.
      Parameters:
      predicate - predicate used to search for the element
      Returns:
      the index of the first element which matches the specified predicate, or -1 if not found
      See Also:
      • invalid reference
        #indexOf(Object)
    • indexOfIf

      public int indexOfIf(Predicate<Integer> predicate, int fromIndex)
      Returns the index of the first element which matches the specified predicate in this list, starting the search at the specified position. If no such element is not found, -1 is returned.
      Parameters:
      predicate - predicate used to search for the element
      Returns:
      the index of the first element which matches the specified predicate, or -1 if not found
      See Also:
      • invalid reference
        #indexOf(Object)
    • doIndexOfIf

      protected int doIndexOfIf(Predicate<Integer> predicate, int fromIndex)
      Returns the index of the first element which matches the specified predicate in this list, starting the search at the specified position. If no such element is not found, -1 is returned.
    • lastIndexOf

      public int lastIndexOf(int elem)
    • lastIndexOf

      public int lastIndexOf(int elem, int fromIndex)
      Returns the index of the last occurrence of the specified element in this list, starting the search at the specified position. If the element is not found, -1 is returned.
      Parameters:
      elem - element to search for
      fromIndex - start index for search
      Returns:
      the index of the last occurrence of the specified element in this list that is less than or equal to fromIndex, or -1 if this list does not contain the element
      See Also:
      • invalid reference
        #lastIndexOf(Object)
    • doLastIndexOf

      protected int doLastIndexOf(int elem, int fromIndex)
      Returns the index of the last occurrence of the specified element in this list, starting the search at the specified position. If the element is not found, -1 is returned.
    • lastIndexOfIf

      public int lastIndexOfIf(Predicate<Integer> predicate)
      Returns the index of the last element which matches the specified predicate in this list. If no such element is not found, -1 is returned.
      Parameters:
      predicate - predicate used to search for the element
      Returns:
      the index of the last element which matches the specified predicate, or -1 if not found
      See Also:
      • invalid reference
        #lastIndexOf(Object)
    • lastIndexOfIf

      public int lastIndexOfIf(Predicate<Integer> predicate, int fromIndex)
      Returns the index of the last occurrence of the specified element in this list, starting the search at the specified position. If the element is not found, -1 is returned.
      Parameters:
      predicate - predicate used to search for the element
      fromIndex - start index for search
      Returns:
      the index of the last occurrence of the specified element in this list that is less than or equal to fromIndex, or -1 if this list does not contain the element
      See Also:
      • invalid reference
        #lastIndexOf(Object)
    • doLastIndexOfIf

      protected int doLastIndexOfIf(Predicate<Integer> predicate, int fromIndex)
      Returns the index of the last occurrence of the specified element in this list, starting the search at the specified position. If the element is not found, -1 is returned.
    • removeElem

      public boolean removeElem(int elem)
    • contains

      public boolean contains(int elem)
    • containsIf

      public boolean containsIf(Predicate<Integer> predicate)
      Determines whether the list contains a matching element.
      Parameters:
      predicate - predicate used to search element
      Returns:
      true if the list contains a matching element, false otherwise
    • addIfAbsent

      public boolean addIfAbsent(int elem)
    • containsAny

      public boolean containsAny(Collection<Integer> 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(Collection<Integer> coll)
    • removeAll

      public IIntList removeAll(int elem)
      Removes all equal elements.
      Parameters:
      elem - element
      Returns:
      removed equal elements (never null)
    • removeAll

      public boolean removeAll(Collection<Integer> coll)
    • removeAll

      public boolean removeAll(IIntList coll)
      See Also:
    • retainAll

      public boolean retainAll(Collection<Integer> coll)
    • retainAll

      public boolean retainAll(IIntList coll)
      See Also:
    • toArray

      public int[] toArray()
    • toArray

      public int[] toArray(int[] array)
    • toArray

      public int[] toArray(Class clazz)
      Returns an array containing the elements in this list.
      Parameters:
      clazz - class for array elements
      Returns:
      array containing the specified elements
    • toArray

      public int[] 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 containing the specified elements
      See Also:
    • toArray

      public int[] toArray(int[] array, int index, int len)
      Returns an array containing the specified elements in this list.
      Parameters:
      array - the array into which the elements of this list are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose
      index - index of first element to copy
      len - number of elements to copy
      Returns:
      array containing the specified elements
      See Also:
    • toArray

      public int[] toArray(Class clazz, int index, int len)
      Returns an array containing the specified elements in this list.
      Parameters:
      clazz - class for array elements
      index - index of first element to copy
      len - number of elements to copy
      Returns:
      array containing the specified elements
    • doCreateArray

      protected int[] doCreateArray(Class clazz, int len)
      Create array.
      Parameters:
      clazz - class for array elements
      len - array length
      Returns:
      created array
    • doGetAll

      protected void doGetAll(int[] array, int index, int len)
      Helper method to fill the specified elements in an array.
      Type Parameters:
      T - type of elements stored in the list
      Parameters:
      array - array to store the list elements
      index - index of first element to copy
      len - number of elements to copy
    • doAddAll

      protected boolean doAddAll(int index, IIntListable list)
      Helper method for adding multiple elements to the list. This default implementation calls doAdd() for adding each element.
      Parameters:
      index - index where element should be added (-1 is valid for adding at the end)
      list - list with elements to add
      Returns:
      true if elements have been added, false otherwise
    • peek

      public int peek()
    • element

      public int element()
    • poll

      public int poll()
    • remove

      public int remove()
    • offer

      public boolean offer(int elem)
    • getFirst

      public int getFirst()
    • getFirstOrNull

      public int getFirstOrNull()
    • getLast

      public int getLast()
    • getLastOrNull

      public int getLastOrNull()
      Returns the last element stored in the list. If the list is empty, null is returned.
      Returns:
      last element stored in the list or null if empty
    • addFirst

      public void addFirst(int elem)
    • addLast

      public void addLast(int elem)
    • removeFirst

      public int removeFirst()
    • removeLast

      public int removeLast()
    • offerFirst

      public boolean offerFirst(int elem)
    • offerLast

      public boolean offerLast(int elem)
    • peekFirst

      public int peekFirst()
    • peekLast

      public int peekLast()
    • pollFirst

      public int pollFirst()
    • pollLast

      public int pollLast()
    • pop

      public int pop()
    • push

      public void push(int elem)
    • removeFirstOccurrence

      public boolean removeFirstOccurrence(int elem)
    • removeLastOccurrence

      public boolean removeLastOccurrence(int elem)
    • transferCopy

      public static void transferCopy(IIntList src, int srcIndex, int srcLen, IIntList dst, int dstIndex, int dstLen)
      Copies elements from one list to another. Elements and size of source list do not change. The elements in the specified range in the destination list are removed and the elements specified to be copied are inserted. If source and destination list are identical, the method behaves like copy(int, int, int).
      Parameters:
      src - source list
      srcIndex - index of first element in source list
      srcLen - number of elements to copy
      dst - destination list
      dstIndex - index of first element in destination list
      dstLen - number of elements to replace in destination list
      type - of elements stored in the list
      Throws:
      IndexOutOfBoundsException - if the ranges are invalid
    • transferMove

      public static void transferMove(IIntList src, int srcIndex, int srcLen, IIntList dst, int dstIndex, int dstLen)
      Moves elements from one list to another by setting it to null in the source list. Elements in the source range are set to null, but size of source list does not change. The elements in the specified range in the destination list are removed and the elements specified to be moved are inserted. If source and destination list are identical, the method behaves like move(int, int, int).
      Parameters:
      src - source list
      srcIndex - index of first element in source list
      srcLen - number of elements to copy
      dst - destination list
      dstIndex - index of first element in destination list
      dstLen - number of elements to replace in destination list
      type - of elements stored in the list
      Throws:
      IndexOutOfBoundsException - if the ranges are invalid
    • transferRemove

      public static void transferRemove(IIntList src, int srcIndex, int srcLen, IIntList dst, int dstIndex, int dstLen)
      Moves elements from one list to another by removing it from the source list. So the size of source list will change. The elements in the specified range in the destination list are removed and the elements specified to be moved are inserted. If source and destination list are identical, the method behaves like drag(int, int, int).
      Parameters:
      src - source list
      srcIndex - index of first element in source list
      srcLen - number of elements to copy
      dst - destination list
      dstIndex - index of first element in destination list
      dstLen - number of elements to replace in destination list
      type - of elements stored in the list
      Throws:
      IndexOutOfBoundsException - if the ranges are invalid
    • doTransfer

      void doTransfer(int transferMode, int srcIndex, int srcLen, IIntList dst, int dstIndex, int dstLen)
    • transferSwap

      public static void transferSwap(IIntList src, int srcIndex, IIntList dst, int dstIndex, int len)
      Swaps elements from two lists. The size of both source and destination list do not change. If source and destination list are identical, the method behaves like swap(int, int, int).
      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
      type - of elements stored in the list
      Throws:
      IndexOutOfBoundsException - if the ranges are invalid
    • doTransferSwap

      void doTransferSwap(int srcIndex, IIntList dst, int dstIndex, int len)
    • doCreate

      protected abstract IIntList doCreate(int capacity)
      Create list with specified capacity.
      Parameters:
      capacity - initial capacity (use -1 for default capacity)
      Returns:
      created list
    • doAssign

      protected abstract void doAssign(IIntList that)
      Assign this list the content of the that list. This is done by bitwise copying so the that list should not be used afterwards.
      Parameters:
      that - list to copy content from
    • getAll

      public IIntList 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:
      list containing the specified range of elements
    • extract

      public IIntList extract(int index, int len)
      Removes specified range of elements from list and return them.
      Parameters:
      index - index of first element to retrieve
      len - number of elements to retrieve
      Returns:
      list containing the specified range of elements
    • retain

      public void retain(int index, int len)
      Retain specified range of elements from list, the other elements are removed.
      Parameters:
      index - index of first element to retain
      len - number of elements to retain
      Throws:
      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:
      IndexOutOfBoundsException - if the range is invalid
    • doRemoveAll

      protected void doRemoveAll(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
    • addAll

      public boolean addAll(IIntList 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:
      NullPointerException - if the specified list is null
    • addAll

      public boolean addAll(int index, IIntList 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:
      IndexOutOfBoundsException - if the index is invalid
      NullPointerException - if the specified collection is null
    • addAll

      public boolean addAll(Collection<Integer> 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.
      Parameters:
      coll - collection containing elements to be added to this list
      Returns:
      true if this list changed as a result of the call
      Throws:
      NullPointerException - if the specified collection is null
    • addAll

      public boolean addAll(int index, Collection<Integer> 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.
      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:
      IndexOutOfBoundsException - if the index is invalid
      NullPointerException - if the specified collection is null
    • addArray

      public boolean addArray(int... 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
    • addArray

      public boolean addArray(int[] elems, int offset, int length)
    • addArray

      public boolean addArray(int index, int[] elems, int offset, int length)
    • addArray

      public boolean addArray(int index, int... 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:
      IndexOutOfBoundsException - if the index is invalid
    • addMult

      public boolean addMult(int len, int elem)
      Adds element multiple time to list.
      Parameters:
      elem - element to be added to this list
      Returns:
      true if this list changed as a result of the call
    • addMult

      public boolean addMult(int index, int len, int elem)
      Inserts element multiple time to 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
      elem - element to be inserted into this list
      Returns:
      true if this list changed as a result of the call
      Throws:
      IndexOutOfBoundsException - if the index is invalid
    • setAll

      public void setAll(int index, IIntList list)
      Sets the specified elements.
      Parameters:
      index - index of first element to set
      list - list with elements to set
    • setAll

      public void setAll(int index, Collection<Integer> coll)
      Sets the specified elements.
      Parameters:
      index - index of first element to set
      coll - collection with elements to set
      Throws:
      IndexOutOfBoundsException - if the range is invalid
    • setArray

      public void setArray(int index, int... elems)
      Sets the specified elements.
      Parameters:
      index - index of first element to set
      elems - array with elements to set
      Throws:
      IndexOutOfBoundsException - if the range is invalid
    • setArray

      public void setArray(int index, int[] elems, int offset, int length)
    • setMult

      public void setMult(int index, int len, int elem)
      Sets the element multiple times.
      Parameters:
      index - index of first element to set
      elem - element to set
    • putAll

      public void putAll(int index, IIntList list)
      Set or add the specified elements.
      Parameters:
      index - index of first element to set or add
      list - list with elements to set or add
    • putAll

      public void putAll(int index, Collection<Integer> coll)
      Set or add the specified elements. If the index is smaller than the size of the list, the existing element is replaced. If the index equals the size of the list, the element is added.
      Parameters:
      index - index of first element to set or add
      coll - collection with elements to set or add
    • doPutAll

      protected void doPutAll(int index, IIntListable list)
    • putArray

      public void putArray(int index, int... elems)
      Set or add the specified elements. If the index is smaller than the size of the list, the existing element is replaced. If the index equals the size of the list, the element is added.
      Parameters:
      index - index of first element to set or add
      elems - array with elements to set or add
    • putMult

      public void putMult(int index, int len, int elem)
      Set or add the specified element multiple times. If the index is smaller than the size of the list, the existing element is replaced. If the index equals the size of the list, the element is added.
      Parameters:
      index - index of first element to set or add
      len - element to set or add
    • initAll

      public void initAll(IIntList list)
      Initializes the list so it will afterwards only contain the elements of the collection. The list will grow or shrink as needed.
      Parameters:
      list - list with elements
      Throws:
      IndexOutOfBoundsException - if the length is invalid
    • doInitAll

      protected void doInitAll(IIntListable list)
    • initAll

      public void initAll(Collection<Integer> coll)
      Initializes the list so it will afterwards only contain the elements of the collection. The list will grow or shrink as needed.
      Parameters:
      coll - collection with elements
      Throws:
      IndexOutOfBoundsException - if the length is invalid
    • asIIntListable

      protected IIntListable asIIntListable(Collection<Integer> coll)
      Return correct IIntListable for passed collection.
    • initArray

      public void initArray(int... elems)
      Initializes the list so it will afterwards only contain the elements of the array. The list will grow or shrink as needed.
      Parameters:
      elems - array with elements
      Throws:
      IndexOutOfBoundsException - if the length is invalid
    • initMult

      public void initMult(int len, int 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:
      IndexOutOfBoundsException - if the length is invalid
    • replaceAll

      public void replaceAll(int index, int len, Collection<Integer> coll)
      Replaces the specified range with new elements. This method is very powerful as it offers the functionality of many other methods which are therefore only offered for convenience:
      - addAll(index, list): replaceAll(index, 0, list)
      - setAll(index, list): replaceAll(index, list.size(), list)
      - putAll(index, list): replaceAll(index, -1, list)
      - initAll(list) : replaceAll(0, this.size(), list)
      - remove(index, list): replaceAll(index, list.size(), null)
      Parameters:
      index - index of first element to replace, use -1 for the position after the last element (this.size())
      len - number of elements to replace, use -1 for getting behavior of putAll()
      coll - collection with elements which replace the old elements, use null if elements should only be removed
      Throws:
      IndexOutOfBoundsException - if the range is invalid
    • replaceArray

      public void replaceArray(int index, int len, int... elems)
      Replaces the specified range with new elements. This method is very powerful as it offers the functionality of many other methods which are therefore only offered for convenience:
      - addAll(index, list): replaceAll(index, 0, list)
      - setAll(index, list): replaceAll(index, list.size(), list)
      - putAll(index, list): replaceAll(index, -1, list)
      - initAll(list) : replaceAll(0, this.size(), list)
      - remove(index, list): replaceAll(index, list.size(), null)
      Parameters:
      index - index of first element to replace, use -1 for the position after the last element (this.size())
      len - number of elements to replace, use -1 for getting behavior of putAll()
      elems - array with elements which replace the old elements, use null if elements should only be removed
      Throws:
      IndexOutOfBoundsException - if the range is invalid
    • replaceMult

      public void replaceMult(int index, int len, int numElems, int elem)
      Replaces the specified range with new elements. This method is very powerful as it offers the functionality of many other methods which are therefore only offered for convenience:
      - addAll(index, list): replaceAll(index, 0, list)
      - setAll(index, list): replaceAll(index, list.size(), list)
      - putAll(index, list): replaceAll(index, -1, list)
      - initAll(list) : replaceAll(0, this.size(), list)
      - remove(index, list): replaceAll(index, list.size(), null)
      Parameters:
      index - index of first element to replace, use -1 for the position after the last element (this.size())
      len - number of elements to replace, use -1 for getting behavior of putAll()
      numElems - number of time element has to be added
      elem - element to add
      Throws:
      IndexOutOfBoundsException - if the range is invalid
    • replaceAll

      public void replaceAll(int index, int len, IIntList list)
      Replaces the specified range with new elements. This method is very powerful as it offers the functionality of many other methods which are therefore only offered for convenience:
      - addAll(index, list): replaceAll(index, 0, list)
      - setAll(index, list): replaceAll(index, list.size(), list)
      - putAll(index, list): replaceAll(index, -1, list)
      - initAll(list) : replaceAll(0, this.size(), list)
      - remove(index, list): replaceAll(index, list.size(), null)
      Parameters:
      index - index of first element to replace, use -1 for the position after the last element (this.size())
      len - number of elements to replace, use -1 for getting behavior of putAll()
      list - list with elements which replace the old elements, use null if elements should only be removed
      Throws:
      IndexOutOfBoundsException - if the range is invalid
    • replace

      protected void replace(int index, int len, IIntListable list)
    • doReplace

      protected boolean doReplace(int index, int len, IIntListable list)
    • fill

      public void fill(int elem)
    • 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:
      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:
      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:
      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:
      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:
      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:
      IndexOutOfBoundsException - if the ranges are invalid
    • doRotate

      protected void doRotate(int index, int len, int distance)
      Internal method to 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
    • sort

      public void sort()
      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:
    • sort

      public abstract void sort(int index, int len)
      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:
      IndexOutOfBoundsException - if the range is invalid
      See Also:
    • binarySearch

      public int binarySearch(int key)
      Searches the specified range for an object using the binary* search algorithm.

      Note that the method is defined to work with an arbitrary type <K>. This allows to search directly for a key field in the object without the need to construct an object containing the key:

      
        persons.binarySearch("john", new SearchByName());
      
        class SearchByName implements Comparator<Object> {
       	 public int compare(Object o1, Object o2) {
       	   String s1 = (o1 instanceof String) ? (String) o1 : ((Name) o1).getName();
       	   String s2 = (o2 instanceof String) ? (String) o2 : ((Name) o2).getName();
       	   return s1.compareTo(s2);
       	 }
        }
        
      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:
    • binarySearch

      public abstract int binarySearch(int index, int len, int key)
      Searches the specified range for an object using the binary search algorithm.

      Note that the method is defined to work with an arbitrary type <K>. This allows to search directly for a key field in the object without the need to construct an object containing the key:

      
        persons.binarySearch("john", new SearchByName());
      
        class SearchByName implements Comparator<Object> {
       	 public int compare(Object o1, Object o2) {
       	   String s1 = (o1 instanceof String) ? (String) o1 : ((Name) o1).getName();
       	   String s2 = (o2 instanceof String) ? (String) o2 : ((Name) o2).getName();
       	   return s1.compareTo(s2);
       	 }
        }
        /
      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:
      IndexOutOfBoundsException - if the range is invalid
      See Also:
    • checkIndex

      protected void checkIndex(int index)
      Check that specified index is valid for getting/setting elements.
      Parameters:
      index - index to check
      Throws:
      IndexOutOfBoundsException - if index is invalid
    • checkIndexAdd

      protected void checkIndexAdd(int index)
      Check that specified index is valid for adding elements.
      Parameters:
      index - index to check
      Throws:
      IndexOutOfBoundsException - if index is invalid
    • checkRange

      protected void checkRange(int index, int len)
      Check that specified range is valid.
      Parameters:
      index - start index of range to check
      len - number of elements in range to check
      Throws:
      IndexOutOfBoundsException - if index is invalid
    • checkLength

      protected void checkLength(int len)
      Check that specified length is valid (>= 0).
      Parameters:
      len - length to check
      Throws:
      IndexOutOfBoundsException - if length is invalid
    • checkLengths

      protected void checkLengths(int len1, int len2)
      Check that both specified lengths are valid (>= 0) and equal.
      Parameters:
      len1 - length to check
      len2 - length to check
      Throws:
      IndexOutOfBoundsException - if lengths are invalid
    • checkNonNull

      protected void checkNonNull(Object obj)
      Check that object is not null.
      Parameters:
      obj - object to check
      Throws:
      NullPointerException - if object is null