Class AbstractShortList

java.lang.Object
java.util.AbstractCollection<java.lang.Short>
it.unimi.dsi.fastutil.shorts.AbstractShortCollection
it.unimi.dsi.fastutil.shorts.AbstractShortList
All Implemented Interfaces:
ShortCollection, ShortIterable, ShortList, ShortStack, Stack<java.lang.Short>, java.lang.Comparable<java.util.List<? extends java.lang.Short>>, java.lang.Iterable<java.lang.Short>, java.util.Collection<java.lang.Short>, java.util.List<java.lang.Short>
Direct Known Subclasses:
AbstractShortList.ShortSubList, ShortArrayList, ShortImmutableList, ShortLists.Singleton

public abstract class AbstractShortList
extends AbstractShortCollection
implements ShortList, ShortStack
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.Short>)) 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.

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static class  AbstractShortList.ShortRandomAccessSubList  
    static class  AbstractShortList.ShortSubList
    A class implementing a sublist view.
  • Method Summary

    Modifier and Type Method Description
    void add​(int index, short k)
    Inserts the specified element at the specified position in this list (optional operation).
    boolean add​(short k)
    Ensures that this collection contains the specified element (optional operation).
    boolean addAll​(int index, ShortCollection c)
    Inserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).
    boolean addAll​(int index, java.util.Collection<? extends java.lang.Short> c)
    Adds all of the elements in the specified collection to this list (optional operation).
    boolean addAll​(ShortCollection c)
    Adds all elements of the given type-specific collection to this collection.
    boolean addAll​(java.util.Collection<? extends java.lang.Short> c)
    void addElements​(int index, short[] a)
    Add (hopefully quickly) elements to this type-specific list.
    void addElements​(int index, short[] a, int offset, int length)
    Add (hopefully quickly) elements to this type-specific list.
    void clear()
    int compareTo​(java.util.List<? extends java.lang.Short> l)
    Compares this list to another object.
    boolean contains​(short k)
    Returns true if this list contains the specified element.
    boolean equals​(java.lang.Object o)  
    void forEach​(ShortConsumer 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.
    void getElements​(int from, short[] a, int offset, int length)
    Copies (hopefully quickly) elements of this type-specific list into the given array.
    int hashCode()
    Returns the hash code for this list, which is identical to List.hashCode().
    int indexOf​(short k)
    Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
    ShortListIterator iterator()
    Returns a type-specific iterator on the elements of this collection.
    int lastIndexOf​(short k)
    Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
    ShortListIterator listIterator()
    Returns a type-specific list iterator on the list.
    ShortListIterator listIterator​(int index)
    Returns a type-specific list iterator on the list starting at a given index.
    short peekShort​(int i)
    Peeks at an element on the stack (optional operation).
    short popShort()
    Pops the top off the stack.
    void push​(short o)
    Pushes the given object on the stack.
    boolean rem​(short k)
    Removes a single instance of the specified element from this collection, if it is present (optional operation).
    void removeElements​(int from, int to)
    Removes (hopefully quickly) elements of this type-specific list.
    short removeShort​(int i)
    Removes the element at the specified position in this list (optional operation).
    short set​(int index, short k)
    Replaces the element at the specified position in this list with the specified element (optional operation).
    void setElements​(int index, short[] a, int offset, int length)
    Set (hopefully quickly) elements to match the array given.
    void size​(int size)
    Sets the size of this list.
    ShortList subList​(int from, int to)
    Returns a type-specific view of the portion of this list from the index from, inclusive, to the index to, exclusive.
    short[] toArray​(short[] a)
    Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.
    short topShort()
    Peeks at the top of the stack (optional operation).
    short[] toShortArray()
    Returns a primitive type array containing the items of this collection.
    java.lang.String toString()  

    Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShortCollection

    add, contains, containsAll, containsAll, remove, removeAll, removeAll, retainAll, retainAll, toShortArray

    Methods inherited from class java.util.AbstractCollection

    isEmpty, size, toArray, toArray

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface java.util.Collection

    toArray

    Methods inherited from interface java.util.List

    containsAll, isEmpty, removeAll, retainAll, size, toArray, toArray

    Methods inherited from interface it.unimi.dsi.fastutil.shorts.ShortIterable

    forEach, forEach

    Methods inherited from interface it.unimi.dsi.fastutil.shorts.ShortStack

    peek, pop, push, top

    Methods inherited from interface it.unimi.dsi.fastutil.Stack

    isEmpty
  • Method Details

    • add

      public void add​(int index, short k)
      Inserts the specified element at the specified position in this list (optional operation).
      Specified by:
      add in interface ShortList
      See Also:
      List.add(int,Object)
      Implementation Specification:
      This implementation always throws an UnsupportedOperationException.
    • add

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

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

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

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

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

      public ShortListIterator iterator()
      Returns a type-specific iterator on the elements of this collection.
      Specified by:
      iterator in interface java.util.Collection<java.lang.Short>
      Specified by:
      iterator in interface java.lang.Iterable<java.lang.Short>
      Specified by:
      iterator in interface java.util.List<java.lang.Short>
      Specified by:
      iterator in interface ShortCollection
      Specified by:
      iterator in interface ShortIterable
      Specified by:
      iterator in interface ShortList
      Specified by:
      iterator in class AbstractShortCollection
      Returns:
      a type-specific iterator on the elements of this collection.
      See Also:
      Iterable.iterator()
      Implementation Specification:
      This implementation delegates to listIterator().
    • listIterator

      public ShortListIterator listIterator()
      Returns a type-specific list iterator on the list.
      Specified by:
      listIterator in interface java.util.List<java.lang.Short>
      Specified by:
      listIterator in interface ShortList
      See Also:
      List.listIterator()
      Implementation Specification:
      This implementation delegates to listIterator(0).
    • listIterator

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

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

      public int indexOf​(short k)
      Description copied from interface: ShortList
      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 ShortList
      See Also:
      List.indexOf(Object)
    • lastIndexOf

      public int lastIndexOf​(short k)
      Description copied from interface: ShortList
      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 ShortList
      See Also:
      List.lastIndexOf(Object)
    • size

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

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

      public void forEach​(ShortConsumer 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 ShortIterable
      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 ShortList
      Parameters:
      from - the start index (inclusive).
      to - the end index (exclusive).
    • addElements

      public void addElements​(int index, short[] 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 ShortList
      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, short[] a)
      Add (hopefully quickly) elements to this type-specific list.
      Specified by:
      addElements in interface ShortList
      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, short[] 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 ShortList
      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, short[] a, int offset, int length)
      Description copied from interface: ShortList
      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 ShortList
      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 java.util.Collection<java.lang.Short>
      Specified by:
      clear in interface java.util.List<java.lang.Short>
      Overrides:
      clear in class java.util.AbstractCollection<java.lang.Short>
      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 java.util.Collection<java.lang.Short>
      Specified by:
      hashCode in interface java.util.List<java.lang.Short>
      Overrides:
      hashCode in class java.lang.Object
      Returns:
      the hash code for this list.
    • equals

      public boolean equals​(java.lang.Object o)
      Specified by:
      equals in interface java.util.Collection<java.lang.Short>
      Specified by:
      equals in interface java.util.List<java.lang.Short>
      Overrides:
      equals in class java.lang.Object
    • compareTo

      public int compareTo​(java.util.List<? extends java.lang.Short> 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 java.lang.Comparable<java.util.List<? extends java.lang.Short>>
      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:
      java.lang.ClassCastException - if the argument is not a list.
    • push

      public void push​(short o)
      Description copied from interface: ShortStack
      Pushes the given object on the stack.
      Specified by:
      push in interface ShortStack
      Parameters:
      o - the object to push on the stack.
      See Also:
      Stack.push(Object)
    • popShort

      public short popShort()
      Description copied from interface: ShortStack
      Pops the top off the stack.
      Specified by:
      popShort in interface ShortStack
      Returns:
      the top of the stack.
      See Also:
      Stack.pop()
    • topShort

      public short topShort()
      Description copied from interface: ShortStack
      Peeks at the top of the stack (optional operation).
      Specified by:
      topShort in interface ShortStack
      Returns:
      the top of the stack.
      See Also:
      Stack.top()
    • peekShort

      public short peekShort​(int i)
      Description copied from interface: ShortStack
      Peeks at an element on the stack (optional operation).
      Specified by:
      peekShort in interface ShortStack
      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​(short k)
      Removes a single instance of the specified element from this collection, if it is present (optional operation).
      Specified by:
      rem in interface ShortCollection
      Overrides:
      rem in class AbstractShortCollection
      See Also:
      List.remove(Object)
      Implementation Specification:
      This implementation delegates to indexOf().
    • toShortArray

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

      public short[] toArray​(short[] a)
      Description copied from interface: ShortCollection
      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 ShortCollection
      Overrides:
      toArray in class AbstractShortCollection
      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, ShortCollection c)
      Description copied from interface: ShortList
      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 ShortList
      See Also:
      List.addAll(int,java.util.Collection)
    • addAll

      public boolean addAll​(ShortCollection c)
      Adds all elements of the given type-specific collection to this collection.
      Specified by:
      addAll in interface ShortCollection
      Overrides:
      addAll in class AbstractShortCollection
      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).
    • toString

      public java.lang.String toString()
      Overrides:
      toString in class AbstractShortCollection