Package it.unimi.dsi.fastutil.objects

Class AbstractObjectList<K>

java.lang.Object
java.util.AbstractCollection<K>
it.unimi.dsi.fastutil.objects.AbstractObjectCollection<K>
it.unimi.dsi.fastutil.objects.AbstractObjectList<K>
All Implemented Interfaces:
ObjectCollection<K>, ObjectIterable<K>, ObjectList<K>, Stack<K>, Comparable<List<? extends K>>, Iterable<K>, Collection<K>, List<K>
Direct Known Subclasses:
AbstractObjectList.ObjectSubList, ByteArrayFrontCodedList, CharArrayFrontCodedList, IntArrayFrontCodedList, LongArrayFrontCodedList, ObjectArrayList, ObjectImmutableList, ObjectLists.Singleton, ShortArrayFrontCodedList
public abstract class AbstractObjectList<K> extends AbstractObjectCollection<K> implements ObjectList<K>, Stack<K>
An abstract class providing basic methods for lists implementing a type-specific list interface.

As an additional bonus, this class implements on top of the list operations a type-specific stack.

Most of the methods in this class are optimized with the assumption that the List will have have constant-time random access. If this is not the case, you should probably at least override listIterator(int) and the xAll() methods (such as addAll(int, java.util.Collection<? extends K>)) with a more appropriate iteration scheme. Note the subList(int, int) method is cognizant of random-access or not, so that need not be reimplemented.

  • Method Details

    • add

      public void add(int index, K k)
      Specified by:
      add in interface List<K>
      Implementation Specification:
      This implementation always throws an UnsupportedOperationException.

    • add

      public boolean add(K k)
      Specified by:
      add in interface Collection<K>
      Specified by:
      add in interface List<K>
      Overrides:
      add in class AbstractCollection<K>
      Implementation Specification:
      This implementation delegates to the type-specific version of List.add(int, Object).

    • remove

      public K remove(int i)
      Specified by:
      remove in interface List<K>
      Implementation Specification:
      This implementation always throws an UnsupportedOperationException.

    • set

      public K set(int index, K k)
      Specified by:
      set in interface List<K>
      Implementation Specification:
      This implementation always throws an UnsupportedOperationException.

    • addAll

      public boolean addAll(int index, Collection<? extends K> c)
      Adds all of the elements in the specified collection to this list (optional operation).
      Specified by:
      addAll in interface List<K>

    • addAll

      public boolean addAll(Collection<? extends K> c)
      Specified by:
      addAll in interface Collection<K>
      Specified by:
      addAll in interface List<K>
      Overrides:
      addAll in class AbstractCollection<K>
      Implementation Specification:
      This implementation delegates to the type-specific version of List.addAll(int, Collection).

    • iterator

      public ObjectListIterator<K> iterator()
      Returns a type-specific iterator on the elements of this collection.
      Specified by:
      iterator in interface Collection<K>
      Specified by:
      iterator in interface Iterable<K>
      Specified by:
      iterator in interface List<K>
      Specified by:
      iterator in interface ObjectCollection<K>
      Specified by:
      iterator in interface ObjectIterable<K>
      Specified by:
      iterator in interface ObjectList<K>
      Specified by:
      iterator in class AbstractObjectCollection<K>
      Returns:
      a type-specific iterator on the elements of this collection.
      See Also:
      Implementation Specification:
      This implementation delegates to listIterator().

    • listIterator

      public ObjectListIterator<K> listIterator()
      Returns a type-specific list iterator on the list.
      Specified by:
      listIterator in interface List<K>
      Specified by:
      listIterator in interface ObjectList<K>
      See Also:
      Implementation Specification:
      This implementation delegates to listIterator(0).

    • listIterator

      public ObjectListIterator<K> listIterator(int index)
      Returns a type-specific list iterator on the list starting at a given index.
      Specified by:
      listIterator in interface List<K>
      Specified by:
      listIterator in interface ObjectList<K>
      See Also:
      Implementation Specification:
      This implementation is based on the random-access methods.

    • contains

      public boolean contains(Object k)
      Returns true if this list contains the specified element.
      Specified by:
      contains in interface Collection<K>
      Specified by:
      contains in interface List<K>
      Overrides:
      contains in class AbstractCollection<K>
      See Also:
      Implementation Specification:
      This implementation delegates to indexOf().

    • indexOf

      public int indexOf(Object k)
      Specified by:
      indexOf in interface List<K>

    • lastIndexOf

      public int lastIndexOf(Object k)
      Specified by:
      lastIndexOf in interface List<K>

    • size

      public void size(int size)
      Description copied from interface: ObjectList
      Sets the size of this list.

      If the specified size is smaller than the current size, the last elements are discarded. Otherwise, they are filled with 0/null/false.

      Specified by:
      size in interface ObjectList<K>
      Parameters:
      size - the new size.

    • subList

      public ObjectList<K> subList(int from, int to)
      Description copied from interface: ObjectList
      Returns a type-specific view of the portion of this list from the index from, inclusive, to the index to, exclusive.
      Specified by:
      subList in interface List<K>
      Specified by:
      subList in interface ObjectList<K>
      See Also:

    • forEach

      public void forEach(Consumer<? super K> action)
      Specified by:
      forEach in interface Iterable<K>
      Implementation Specification:
      If this list is RandomAccess, will iterate using a for loop and the type-specific List.get(int) method. Otherwise it will fallback to using the iterator based loop implementation from the superinterface.

    • removeElements

      public void removeElements(int from, int to)
      Removes (hopefully quickly) elements of this type-specific list.

      This is a trivial iterator-based based implementation. It is expected that implementations will override this method with a more optimized version.

      Specified by:
      removeElements in interface ObjectList<K>
      Parameters:
      from - the start index (inclusive).
      to - the end index (exclusive).

    • addElements

      public void addElements(int index, K[] a, int offset, int length)
      Add (hopefully quickly) elements to this type-specific list.

      This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.

      Specified by:
      addElements in interface ObjectList<K>
      Parameters:
      index - the index at which to add elements.
      a - the array containing the elements.
      offset - the offset of the first element to add.
      length - the number of elements to add.

    • addElements

      public void addElements(int index, K[] a)
      Add (hopefully quickly) elements to this type-specific list.
      Specified by:
      addElements in interface ObjectList<K>
      Parameters:
      index - the index at which to add elements.
      a - the array containing the elements.
      Implementation Specification:
      This implementation delegates to the analogous method for array fragments.

    • getElements

      public void getElements(int from, Object[] a, int offset, int length)
      Copies (hopefully quickly) elements of this type-specific list into the given array.

      This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.

      Specified by:
      getElements in interface ObjectList<K>
      Parameters:
      from - the start index (inclusive).
      a - the destination array.
      offset - the offset into the destination array where to store the first element copied.
      length - the number of elements to be copied.

    • setElements

      public void setElements(int index, K[] a, int offset, int length)
      Description copied from interface: ObjectList
      Set (hopefully quickly) elements to match the array given. Sets each in this list to the corresponding elements in the array, as if by 
       ListIterator iter = listIterator(index);
 int i = 0;
 while (i < length) {
        iter.next();
        iter.set(a[offset + i++]);
 }
      However, the exact implementation may be more efficient, taking into account whether random access is faster or not, or at the discretion of subclasses, abuse internals.
      Specified by:
      setElements in interface ObjectList<K>
      Parameters:
      index - the index at which to start setting elements.
      a - the array containing the elements
      offset - the offset of the first element to add.
      length - the number of elements to add.

    • clear

      public void clear()
      Specified by:
      clear in interface Collection<K>
      Specified by:
      clear in interface List<K>
      Overrides:
      clear in class AbstractCollection<K>
      Implementation Specification:
      This implementation delegates to removeElements(int, int).

    • toArray

      public Object[] toArray()
      Specified by:
      toArray in interface Collection<K>
      Specified by:
      toArray in interface List<K>
      Overrides:
      toArray in class AbstractCollection<K>

    • toArray

      public <T> T[] toArray(T[] a)
      Specified by:
      toArray in interface Collection<K>
      Specified by:
      toArray in interface List<K>
      Overrides:
      toArray in class AbstractCollection<K>

    • hashCode

      public int hashCode()
      Returns the hash code for this list, which is identical to List.hashCode().
      Specified by:
      hashCode in interface Collection<K>
      Specified by:
      hashCode in interface List<K>
      Overrides:
      hashCode in class Object
      Returns:
      the hash code for this list.

    • equals

      public boolean equals(Object o)
      Specified by:
      equals in interface Collection<K>
      Specified by:
      equals in interface List<K>
      Overrides:
      equals in class Object

    • compareTo

      public int compareTo(List<? extends K> l)
      Compares this list to another object. If the argument is a List, this method performs a lexicographical comparison; otherwise, it throws a ClassCastException.
      Specified by:
      compareTo in interface Comparable<K>
      Parameters:
      l - a list.
      Returns:
      if the argument is a List, a negative integer, zero, or a positive integer as this list is lexicographically less than, equal to, or greater than the argument.
      Throws:
      ClassCastException - if the argument is not a list.

    • push

      public void push(K o)
      Description copied from interface: Stack
      Pushes the given object on the stack.
      Specified by:
      push in interface Stack<K>
      Parameters:
      o - the object that will become the new top of the stack.

    • pop

      public K pop()
      Description copied from interface: Stack
      Pops the top off the stack.
      Specified by:
      pop in interface Stack<K>
      Returns:
      the top of the stack.

    • top

      public K top()
      Description copied from interface: Stack
      Peeks at the top of the stack (optional operation).

      This default implementation returns peek(0).

      Specified by:
      top in interface Stack<K>
      Returns:
      the top of the stack.

    • peek

      public K peek(int i)
      Description copied from interface: Stack
      Peeks at an element on the stack (optional operation).

      This default implementation just throws an UnsupportedOperationException.

      Specified by:
      peek in interface Stack<K>
      Parameters:
      i - an index from the stop of the stack (0 represents the top).
      Returns:
      the i-th element on the stack.

    • toString

      public String toString()
      Overrides:
      toString in class AbstractObjectCollection<K>