Package etithespirit.orimod.util.collection

Class WeakList<E>

java.lang.Object
etithespirit.orimod.util.collection.WeakList<E>
All Implemented Interfaces:
Iterable<E>, Collection<E>, List<E>
public class WeakList<E> extends Object implements List<E>

  • Constructor Summary

    Constructors
    Constructor
    Description
    WeakList()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(int index, E element)
    Inserts the specified element at the specified position in this list (optional operation).
    boolean
    add(E e)
    Appends the specified element to the end of this list (optional operation).
    boolean
    add(EquatableWeakReference<E> e)
    Adds the given element to the end of this list.
    boolean
    add(WeakReference<E> e)
     
    boolean
    addAll(int index, @NotNull Collection<? extends E> c)
    Inserts all of the elements in the specified collection into this list at the specified position (optional operation).
    boolean
    addAll(@NotNull Collection<? extends E> c)
    Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator (optional operation).
    void
    clear()
    Removes all of the elements from this list (optional operation).
    boolean
    contains(Object o)
    Returns true if this list contains the specified element.
    boolean
    containsAll(@NotNull Collection<?> c)
    Returns true if this list contains all of the elements of the specified collection.
    E
    get(int index)
    Returns the element at the specified position in this list.
    int
    indexOf(Object o)
    Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
    boolean
    isEmpty()
    Returns true if this list contains no elements.
    @NotNull Iterator<E>
    iterator()
    Returns an iterator over the elements in this list in proper sequence.
    int
    lastIndexOf(Object o)
    Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
    @NotNull ListIterator<E>
    listIterator()
    Returns a list iterator over the elements in this list (in proper sequence).
    @NotNull ListIterator<E>
    listIterator(int index)
    Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list.
    E
    remove(int index)
    Removes the element at the specified position in this list (optional operation).
    boolean
    remove(Object o)
    Removes the first occurrence of the specified element from this list, if it is present (optional operation).
    boolean
    removeAll(@NotNull Collection<?> c)
    Removes from this list all of its elements that are contained in the specified collection (optional operation).
    boolean
    retainAll(@NotNull Collection<?> c)
    Retains only the elements in this list that are contained in the specified collection (optional operation).
    E
    set(int index, E element)
    Replaces the element at the specified position in this list with the specified element (optional operation).
    int
    size()
    Returns the number of elements in this list.
    @NotNull List<E>
    subList(int fromIndex, int toIndex)
    Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.
    @NotNull Object[]
    toArray()
    Returns an array containing all of the elements in this list in proper sequence (from first to last element).
    <T> @NotNull T[]
    toArray(@NotNull T[] a)
    Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface java.util.Collection

    parallelStream, removeIf, stream, toArray

    Methods inherited from interface java.lang.Iterable

    forEach

    Methods inherited from interface java.util.List

    equals, hashCode, replaceAll, sort, spliterator

  • Constructor Details

    • WeakList

      public WeakList()

  • Method Details

    • size

      public int size()
      Returns the number of elements in this list. If this list contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
      Specified by:
      size in interface Collection<E>
      Specified by:
      size in interface List<E>
      Returns:
      the number of elements in this list

    • isEmpty

      public boolean isEmpty()
      Returns true if this list contains no elements.
      Specified by:
      isEmpty in interface Collection<E>
      Specified by:
      isEmpty in interface List<E>
      Returns:
      true if this list contains no elements

    • contains

      public boolean contains(Object o)
      Returns true if this list contains the specified element. More formally, returns true if and only if this list contains at least one element e such that Objects.equals(o, e).
      Specified by:
      contains in interface Collection<E>
      Specified by:
      contains in interface List<E>
      Parameters:
      o - element whose presence in this list is to be tested
      Returns:
      true if this list contains the specified element
      Throws:
      ClassCastException - if the type of the specified element is incompatible with this list (optional)
      NullPointerException - if the specified element is null and this list does not permit null elements (optional)

    • iterator

      @NotNull public @NotNull Iterator<E> iterator()
      Returns an iterator over the elements in this list in proper sequence.
      Specified by:
      iterator in interface Collection<E>
      Specified by:
      iterator in interface Iterable<E>
      Specified by:
      iterator in interface List<E>
      Returns:
      an iterator over the elements in this list in proper sequence

    • toArray

      @NotNull public @NotNull Object[] toArray()
      Returns an array containing all of the elements in this list in proper sequence (from first to last element).

      The returned array will be "safe" in that no references to it are maintained by this list. (In other words, this method must allocate a new array even if this list 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.

      Specified by:
      toArray in interface Collection<E>
      Specified by:
      toArray in interface List<E>
      Returns:
      an array containing all of the elements in this list in proper sequence
      See Also:
      • Arrays#asList(Object[])

    • toArray

      @NotNull public <T> @NotNull T[] toArray(@NotNull @NotNull T[] a)
      Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array. If the list 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 list.

      If the list fits in the specified array with room to spare (i.e., the array has more elements than the list), the element in the array immediately following the end of the list is set to null. (This is useful in determining the length of the list only if the caller knows that the list does not contain any null elements.)

      Like the 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 list known to contain only strings. The following code can be used to dump the list 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().

      Specified by:
      toArray in interface Collection<E>
      Specified by:
      toArray in interface List<E>
      Parameters:
      a - 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.
      Returns:
      an array containing the elements of this list
      Throws:
      ArrayStoreException - if the runtime type of the specified array is not a supertype of the runtime type of every element in this list
      NullPointerException - if the specified array is null

    • add

      public boolean add(E e)
      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.

      Specified by:
      add in interface Collection<E>
      Specified by:
      add in interface List<E>
      Parameters:
      e - element to be appended to this list
      Returns:
      true (as specified by Collection.add(E))
      Throws:
      UnsupportedOperationException - if the add operation is not supported by this list
      ClassCastException - if the class of the specified element prevents it from being added to this list
      NullPointerException - if the specified element is null and this list does not permit null elements
      IllegalArgumentException - if some property of this element prevents it from being added to this list

    • add

      public boolean add(WeakReference<E> e)

    • add

      public boolean add(EquatableWeakReference<E> e)
      Adds the given element to the end of this list.
      Parameters:
      e - The element, already boxed in a weak reference.
      Returns:
      true (as specified by Collection.add(E))

    • remove

      public boolean remove(Object o)
      Removes the first occurrence of the specified element from this list, if it is present (optional operation). If this list does not contain the element, it is unchanged. More formally, removes the element with the lowest index i such that Objects.equals(o, get(i)) (if such an element exists). Returns true if this list contained the specified element (or equivalently, if this list changed as a result of the call).
      Specified by:
      remove in interface Collection<E>
      Specified by:
      remove in interface List<E>
      Parameters:
      o - element to be removed from this list, if present
      Returns:
      true if this list contained the specified element
      Throws:
      ClassCastException - if the type of the specified element is incompatible with this list (optional)
      NullPointerException - if the specified element is null and this list does not permit null elements (optional)
      UnsupportedOperationException - if the remove operation is not supported by this list

    • containsAll

      public boolean containsAll(@NotNull @NotNull Collection<?> c)
      Returns true if this list contains all of the elements of the specified collection.
      Specified by:
      containsAll in interface Collection<E>
      Specified by:
      containsAll in interface List<E>
      Parameters:
      c - collection to be checked for containment in this list
      Returns:
      true if this list contains all of the elements of the specified collection
      Throws:
      ClassCastException - if the types of one or more elements in the specified collection are incompatible with this list (optional)
      NullPointerException - if the specified collection contains one or more null elements and this list does not permit null elements (optional), or if the specified collection is null
      See Also:

    • addAll

      public boolean addAll(@NotNull @NotNull Collection<? extends E> c)
      Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)
      Specified by:
      addAll in interface Collection<E>
      Specified by:
      addAll in interface List<E>
      Parameters:
      c - collection containing elements to be added to this list
      Returns:
      true if this list changed as a result of the call
      Throws:
      UnsupportedOperationException - if the addAll operation is not supported by this list
      ClassCastException - if the class of an element of the specified collection prevents it from being added to this list
      NullPointerException - if the specified collection contains one or more null elements and this list does not permit null elements, or if the specified collection is null
      IllegalArgumentException - if some property of an element of the specified collection prevents it from being added to this list
      See Also:

    • addAll

      public boolean addAll(int index, @NotNull @NotNull Collection<? extends E> c)
      Inserts all of the elements in the specified collection into this list at the specified position (optional operation). 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 this list in the order that they are returned by the specified collection's iterator. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)
      Specified by:
      addAll in interface List<E>
      Parameters:
      index - index at which to insert the first element from the specified collection
      c - collection containing elements to be added to this list
      Returns:
      true if this list changed as a result of the call
      Throws:
      UnsupportedOperationException - if the addAll operation is not supported by this list
      ClassCastException - if the class of an element of the specified collection prevents it from being added to this list
      NullPointerException - if the specified collection contains one or more null elements and this list does not permit null elements, or if the specified collection is null
      IllegalArgumentException - if some property of an element of the specified collection prevents it from being added to this list
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size())

    • removeAll

      public boolean removeAll(@NotNull @NotNull Collection<?> c)
      Removes from this list all of its elements that are contained in the specified collection (optional operation).
      Specified by:
      removeAll in interface Collection<E>
      Specified by:
      removeAll in interface List<E>
      Parameters:
      c - collection containing elements to be removed from this list
      Returns:
      true if this list changed as a result of the call
      Throws:
      UnsupportedOperationException - if the removeAll operation is not supported by this list
      ClassCastException - if the class of an element of this list is incompatible with the specified collection (optional)
      NullPointerException - if this list contains a null element and the specified collection does not permit null elements (optional), or if the specified collection is null
      See Also:

    • retainAll

      public boolean retainAll(@NotNull @NotNull Collection<?> c)
      Retains only the elements in this list that are contained in the specified collection (optional operation). In other words, removes from this list all of its elements that are not contained in the specified collection.
      Specified by:
      retainAll in interface Collection<E>
      Specified by:
      retainAll in interface List<E>
      Parameters:
      c - collection containing elements to be retained in this list
      Returns:
      true if this list changed as a result of the call
      Throws:
      UnsupportedOperationException - if the retainAll operation is not supported by this list
      ClassCastException - if the class of an element of this list is incompatible with the specified collection (optional)
      NullPointerException - if this list contains a null element and the specified collection does not permit null elements (optional), or if the specified collection is null
      See Also:

    • clear

      public void clear()
      Removes all of the elements from this list (optional operation). The list will be empty after this call returns.
      Specified by:
      clear in interface Collection<E>
      Specified by:
      clear in interface List<E>
      Throws:
      UnsupportedOperationException - if the clear operation is not supported by this list

    • get

      public E get(int index)
      Returns the element at the specified position in this list.
      Specified by:
      get in interface List<E>
      Parameters:
      index - index of the element to return
      Returns:
      the element at the specified position in this list
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • set

      public E set(int index, E element)
      Replaces the element at the specified position in this list with the specified element (optional operation).
      Specified by:
      set in interface List<E>
      Parameters:
      index - index of the element to replace
      element - element to be stored at the specified position
      Returns:
      the element previously at the specified position
      Throws:
      UnsupportedOperationException - if the set operation is not supported by this list
      ClassCastException - if the class of the specified element prevents it from being added to this list
      NullPointerException - if the specified element is null and this list does not permit null elements
      IllegalArgumentException - if some property of the specified element prevents it from being added to this list
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • add

      public void add(int index, E element)
      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).
      Specified by:
      add in interface List<E>
      Parameters:
      index - index at which the specified element is to be inserted
      element - element to be inserted
      Throws:
      UnsupportedOperationException - if the add operation is not supported by this list
      ClassCastException - if the class of the specified element prevents it from being added to this list
      NullPointerException - if the specified element is null and this list does not permit null elements
      IllegalArgumentException - if some property of the specified element prevents it from being added to this list
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size())

    • remove

      public E remove(int index)
      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.
      Specified by:
      remove in interface List<E>
      Parameters:
      index - the index of the element to be removed
      Returns:
      the element previously at the specified position
      Throws:
      UnsupportedOperationException - if the remove operation is not supported by this list
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • indexOf

      public int indexOf(Object o)
      Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the lowest index i such that Objects.equals(o, get(i)), or -1 if there is no such index.
      Specified by:
      indexOf in interface List<E>
      Parameters:
      o - 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
      Throws:
      ClassCastException - if the type of the specified element is incompatible with this list (optional)
      NullPointerException - if the specified element is null and this list does not permit null elements (optional)

    • lastIndexOf

      public int lastIndexOf(Object o)
      Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the highest index i such that Objects.equals(o, get(i)), or -1 if there is no such index.
      Specified by:
      lastIndexOf in interface List<E>
      Parameters:
      o - 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
      Throws:
      ClassCastException - if the type of the specified element is incompatible with this list (optional)
      NullPointerException - if the specified element is null and this list does not permit null elements (optional)

    • listIterator

      @NotNull public @NotNull ListIterator<E> listIterator()
      Returns a list iterator over the elements in this list (in proper sequence).
      Specified by:
      listIterator in interface List<E>
      Returns:
      a list iterator over the elements in this list (in proper sequence)

    • listIterator

      @NotNull public @NotNull ListIterator<E> listIterator(int index)
      Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the 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.
      Specified by:
      listIterator in interface List<E>
      Parameters:
      index - index of the first element to be returned from the list iterator (by a call to next)
      Returns:
      a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size())

    • subList

      @NotNull public @NotNull List<E> subList(int fromIndex, int toIndex)
      Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive. (If fromIndex and toIndex are equal, the returned list is empty.) The returned list is backed by this list, so non-structural changes in the returned list are reflected in this list, and vice-versa. The returned list supports all of the optional list operations supported by this list.

      This method eliminates the need for explicit range operations (of the sort that commonly exist for arrays). Any operation that expects a list can be used as a range operation by passing a subList view instead of a whole list. For example, the following idiom removes a range of elements from a list: 

      
      list.subList(from, to).clear();
      Similar idioms may be constructed for indexOf and lastIndexOf, and all of the algorithms in the Collections class can be applied to a subList.

      The semantics of the list returned by this method become undefined if the backing list (i.e., this list) is structurally modified in any way other than via the returned list. (Structural modifications are those that change the size of this list, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results.)

      Specified by:
      subList in interface List<E>
      Parameters:
      fromIndex - low endpoint (inclusive) of the subList
      toIndex - high endpoint (exclusive) of the subList
      Returns:
      a view of the specified range within this list
      Throws:
      IndexOutOfBoundsException - for an illegal endpoint index value (fromIndex < 0 || toIndex > size || fromIndex > toIndex)