it.unimi.dsi.fastutil.objects.AbstractReferenceList<K>

All Implemented Interfaces:: ObjectIterable<K>, ReferenceCollection<K>, ReferenceList<K>, Stack<K>, Iterable<K>, Collection<K>, List<K>

Direct Known Subclasses:: AbstractReferenceList.ReferenceSubList, ReferenceArrayList, ReferenceLists.Singleton

public abstract class AbstractReferenceList<K>
extends AbstractReferenceCollection<K>
implements ReferenceList<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.

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class AbstractReferenceList.ReferenceSubList<K>
A class implementing a sublist view.

Method Summary

Modifier and Type	Method	Description
`void`	`add(int index, K k)`
`boolean`	`add(K k)`
`boolean`	`addAll(int index, Collection<? extends K> c)`	Adds all of the elements in the specified collection to this list (optional operation).
`boolean`	`addAll(Collection<? extends K> c)`
`void`	`addElements(int index, K[] a)`	Add (hopefully quickly) elements to this type-specific list.
`void`	`addElements(int index, K[] a, int offset, int length)`	Add (hopefully quickly) elements to this type-specific list.
`void`	`clear()`
`boolean`	`contains(Object k)`	Returns true if this list contains the specified element.
`boolean`	`equals(Object o)`
`void`	`getElements(int from, Object[] 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(Object k)`
`ObjectListIterator<K>`	`iterator()`	Returns a type-specific iterator on the elements of this collection.
`int`	`lastIndexOf(Object k)`
`ObjectListIterator<K>`	`listIterator()`	Returns a type-specific list iterator on the list.
`ObjectListIterator<K>`	`listIterator(int index)`	Returns a type-specific list iterator on the list starting at a given index.
`K`	`peek(int i)`	Peeks at an element on the stack (optional operation).
`K`	`pop()`	Pops the top off the stack.
`void`	`push(K o)`	Pushes the given object on the stack.
`K`	`remove(int i)`
`void`	`removeElements(int from, int to)`	Removes (hopefully quickly) elements of this type-specific list.
`K`	`set(int index, K k)`
`void`	`size(int size)`	Sets the size of this list.
`ReferenceList<K>`	`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.
`K`	`top()`	Peeks at the top of the stack (optional operation).
`String`	`toString()`

Methods inherited from class java.util.AbstractCollection

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, 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

containsAll, get, isEmpty, remove, removeAll, replaceAll, retainAll, size, sort, spliterator, toArray, toArray

Methods inherited from interface it.unimi.dsi.fastutil.objects.ReferenceList

setElements, setElements, setElements, unstableSort

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

isEmpty

Method Details
- add
  
  public void add(int index, K k)
  
  This implementation always throws an UnsupportedOperationException.
  
  Specified by:
  
  add in interface List<K>
- add
  
  public boolean add(K k)
  
  This implementation delegates to the type-specific version of List.add(int, Object).
  
  Specified by:
  
  add in interface Collection<K>
  
  Specified by:
  
  add in interface List<K>
  
  Overrides:
  
  add in class AbstractCollection<K>
- remove
  
  public K remove(int i)
  
  This implementation always throws an UnsupportedOperationException.
  
  Specified by:
  
  remove in interface List<K>
- set
  
  public K set(int index, K k)
  
  This implementation always throws an UnsupportedOperationException.
  
  Specified by:
  
  set in interface List<K>
- 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)
  
  This implementation delegates to the type-specific version of List.addAll(int, Collection).
  
  Specified by:
  
  addAll in interface Collection<K>
  
  Specified by:
  
  addAll in interface List<K>
  
  Overrides:
  
  addAll in class AbstractCollection<K>
- iterator
  
  public ObjectListIterator<K> iterator()
  
  Returns a type-specific iterator on the elements of this collection.
  Note that this specification strengthens the one given in Iterable.iterator(), which was already strengthened in the corresponding type-specific class, but was weakened by the fact that this interface extends Collection.
  This implementation delegates to listIterator().
  
  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 ObjectIterable<K>
  
  Specified by:
  
  iterator in interface ReferenceCollection<K>
  
  Specified by:
  
  iterator in interface ReferenceList<K>
  
  Specified by:
  
  iterator in class AbstractReferenceCollection<K>
  
  Returns:
  
  a type-specific iterator on the elements of this collection.
  
  See Also:
  
  Iterable.iterator()
- listIterator
  
  public ObjectListIterator<K> listIterator()
  
  Returns a type-specific list iterator on the list.
  This implementation delegates to listIterator(0).
  
  Specified by:
  
  listIterator in interface List<K>
  
  Specified by:
  
  listIterator in interface ReferenceList<K>
  
  See Also:
  
  List.listIterator()
- listIterator
  
  public ObjectListIterator<K> listIterator(int index)
  
  Returns a type-specific list iterator on the list starting at a given index.
  This implementation is based on the random-access methods.
  
  Specified by:
  
  listIterator in interface List<K>
  
  Specified by:
  
  listIterator in interface ReferenceList<K>
  
  See Also:
  
  List.listIterator(int)
- contains
  
  public boolean contains(Object k)
  
  Returns true if this list contains the specified element.
  This implementation delegates to indexOf().
  
  Specified by:
  
  contains in interface Collection<K>
  
  Specified by:
  
  contains in interface List<K>
  
  Overrides:
  
  contains in class AbstractCollection<K>
  
  See Also:
  
  List.contains(Object)
- 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: ReferenceList
  
  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 ReferenceList<K>
  
  Parameters:
  
  size - the new size.
- subList
  
  public ReferenceList<K> subList(int from, int to)
  
  Description copied from interface: ReferenceList
  
  Returns a type-specific view of the portion of this list from the index from, inclusive, to the index to, exclusive.
  Note that this specification strengthens the one given in List.subList(int,int).
  
  Specified by:
  
  subList in interface List<K>
  
  Specified by:
  
  subList in interface ReferenceList<K>
  
  See Also:
  
  List.subList(int,int)
- removeElements
  
  public void removeElements(int from, int to)
  
  Removes (hopefully quickly) elements of 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:
  
  removeElements in interface ReferenceList<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 ReferenceList<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.
  This implementation delegates to the analogous method for array fragments.
  
  Specified by:
  
  addElements in interface ReferenceList<K>
  
  Parameters:
  
  index - the index at which to add elements.
  
  a - the array containing the elements.
- 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 ReferenceList<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.
- clear
  
  public void clear()
  
  This implementation delegates to removeElements(int, int).
  
  Specified by:
  
  clear in interface Collection<K>
  
  Specified by:
  
  clear in interface List<K>
  
  Overrides:
  
  clear 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
- 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 AbstractReferenceCollection<K>

Class AbstractReferenceList<K>

Nested Class Summary