Class AbstractLongList

All Implemented Interfaces:
LongCollection, LongIterable, LongList, LongStack, Stack<Long>, Comparable<List<? extends Long>>, Iterable<Long>, Collection<Long>, List<Long>
Direct Known Subclasses:
AbstractLongList.LongSubList, LongArrayList, LongImmutableList, LongLists.Singleton

public abstract class AbstractLongList
extends AbstractLongCollection
implements LongList, LongStack
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 java.lang.Long>)) 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, long k)
      Inserts the specified element at the specified position in this list (optional operation).
      Specified by:
      add in interface LongList
      See Also:
      List.add(int,Object)
      Implementation Specification:
      This implementation always throws an UnsupportedOperationException.
    • add

      public boolean add​(long k)
      Ensures that this collection contains the specified element (optional operation).
      Specified by:
      add in interface LongCollection
      Specified by:
      add in interface LongList
      Overrides:
      add in class AbstractLongCollection
      See Also:
      Collection.add(Object)
      Implementation Specification:
      This implementation delegates to the type-specific version of List.add(int, Object).
    • removeLong

      public long removeLong​(int i)
      Removes the element at the specified position in this list (optional operation).
      Specified by:
      removeLong in interface LongList
      See Also:
      List.remove(int)
      Implementation Specification:
      This implementation always throws an UnsupportedOperationException.
    • set

      public long set​(int index, long k)
      Replaces the element at the specified position in this list with the specified element (optional operation).
      Specified by:
      set in interface LongList
      See Also:
      List.set(int,Object)
      Implementation Specification:
      This implementation always throws an UnsupportedOperationException.
    • addAll

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

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

      public LongListIterator iterator()
      Returns a type-specific iterator on the elements of this collection.
      Specified by:
      iterator in interface Collection<Long>
      Specified by:
      iterator in interface Iterable<Long>
      Specified by:
      iterator in interface List<Long>
      Specified by:
      iterator in interface LongCollection
      Specified by:
      iterator in interface LongIterable
      Specified by:
      iterator in interface LongList
      Specified by:
      iterator in class AbstractLongCollection
      Returns:
      a type-specific iterator on the elements of this collection.
      See Also:
      Iterable.iterator()
      Implementation Specification:
      This implementation delegates to listIterator().
    • listIterator

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

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

      public boolean contains​(long k)
      Returns true if this list contains the specified element.
      Specified by:
      contains in interface LongCollection
      Overrides:
      contains in class AbstractLongCollection
      See Also:
      List.contains(Object)
      Implementation Specification:
      This implementation delegates to indexOf().
    • indexOf

      public int indexOf​(long k)
      Description copied from interface: LongList
      Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
      Specified by:
      indexOf in interface LongList
      See Also:
      List.indexOf(Object)
    • lastIndexOf

      public int lastIndexOf​(long k)
      Description copied from interface: LongList
      Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
      Specified by:
      lastIndexOf in interface LongList
      See Also:
      List.lastIndexOf(Object)
    • size

      public void size​(int size)
      Description copied from interface: LongList
      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 LongList
      Parameters:
      size - the new size.
    • subList

      public LongList subList​(int from, int to)
      Description copied from interface: LongList
      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<Long>
      Specified by:
      subList in interface LongList
      See Also:
      List.subList(int,int)
    • forEach

      public void forEach​(LongConsumer action)
      Performs the given action for each element of this type-specific Iterable until all elements have been processed or the action throws an exception.
      Specified by:
      forEach in interface LongIterable
      Parameters:
      action - the action to be performed for each element.
      See Also:
      Iterable.forEach(java.util.function.Consumer)
      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 LongList
      Parameters:
      from - the start index (inclusive).
      to - the end index (exclusive).
    • addElements

      public void addElements​(int index, long[] 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 LongList
      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, long[] a)
      Add (hopefully quickly) elements to this type-specific list.
      Specified by:
      addElements in interface LongList
      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, long[] 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 LongList
      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, long[] a, int offset, int length)
      Description copied from interface: LongList
      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 LongList
      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<Long>
      Specified by:
      clear in interface List<Long>
      Overrides:
      clear in class AbstractCollection<Long>
      Implementation Specification:
      This implementation delegates to removeElements(int, int).
    • hashCode

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

      public boolean equals​(Object o)
      Specified by:
      equals in interface Collection<Long>
      Specified by:
      equals in interface List<Long>
      Overrides:
      equals in class Object
    • compareTo

      public int compareTo​(List<? extends Long> 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<List<? extends Long>>
      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​(long o)
      Description copied from interface: LongStack
      Pushes the given object on the stack.
      Specified by:
      push in interface LongStack
      Parameters:
      o - the object to push on the stack.
      See Also:
      Stack.push(Object)
    • popLong

      public long popLong()
      Description copied from interface: LongStack
      Pops the top off the stack.
      Specified by:
      popLong in interface LongStack
      Returns:
      the top of the stack.
      See Also:
      Stack.pop()
    • topLong

      public long topLong()
      Description copied from interface: LongStack
      Peeks at the top of the stack (optional operation).
      Specified by:
      topLong in interface LongStack
      Returns:
      the top of the stack.
      See Also:
      Stack.top()
    • peekLong

      public long peekLong​(int i)
      Description copied from interface: LongStack
      Peeks at an element on the stack (optional operation).
      Specified by:
      peekLong in interface LongStack
      Parameters:
      i - an index from the stop of the stack (0 represents the top).
      Returns:
      the i-th element on the stack.
      See Also:
      Stack.peek(int)
    • rem

      public boolean rem​(long k)
      Removes a single instance of the specified element from this collection, if it is present (optional operation).
      Specified by:
      rem in interface LongCollection
      Overrides:
      rem in class AbstractLongCollection
      See Also:
      List.remove(Object)
      Implementation Specification:
      This implementation delegates to indexOf().
    • toLongArray

      public long[] toLongArray()
      Description copied from interface: LongCollection
      Returns a primitive type array containing the items of this collection.
      Specified by:
      toLongArray in interface LongCollection
      Overrides:
      toLongArray in class AbstractLongCollection
      Returns:
      a primitive type array containing the items of this collection.
      See Also:
      Collection.toArray()
    • toArray

      public long[] toArray​(long[] a)
      Description copied from interface: LongCollection
      Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.

      Note that, contrarily to Collection.toArray(Object[]), this methods just writes all elements of this collection: no special value will be added after the last one.

      Specified by:
      toArray in interface LongCollection
      Overrides:
      toArray in class AbstractLongCollection
      Parameters:
      a - if this array is big enough, it will be used to store this collection.
      Returns:
      a primitive type array containing the items of this collection.
      See Also:
      Collection.toArray(Object[])
    • addAll

      public boolean addAll​(int index, LongCollection c)
      Description copied from interface: LongList
      Inserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).
      Specified by:
      addAll in interface LongList
      See Also:
      List.addAll(int,java.util.Collection)
    • addAll

      public boolean addAll​(LongCollection c)
      Adds all elements of the given type-specific collection to this collection.
      Specified by:
      addAll in interface LongCollection
      Overrides:
      addAll in class AbstractLongCollection
      Parameters:
      c - a type-specific collection.
      Returns:
      true if this collection changed as a result of the call.
      See Also:
      Collection.addAll(Collection)
      Implementation Specification:
      This implementation delegates to the type-specific version of List.addAll(int, Collection).
    • replaceAll

      public final void replaceAll​(LongUnaryOperator operator)
      Replaces each element of this list with the result of applying the operator to that element.

      WARNING: Overriding this method is almost always a mistake, as this overload only exists to disambiguate. Instead, override the replaceAll() overload that uses the JDK's primitive unary operator type (e.g. IntUnaryOperator).

      If Java supported final default methods, this would be one, but sadly it does not.

      If you checked and are overriding the version with java.util.function.XUnaryOperator, and still see this warning, then your IDE is incorrectly conflating this method with the proper method to override, and you can safely ignore this message.

      Specified by:
      replaceAll in interface LongList
      Parameters:
      operator - the operator to apply to each element
      See Also:
      List.replaceAll(java.util.function.UnaryOperator<E>)
      Implementation Specification:
      This method just delegates to the interface default method, as the default method, but it is final, so it cannot be overridden.
    • toString

      public String toString()
      Overrides:
      toString in class AbstractLongCollection