Package it.unimi.dsi.fastutil.objects

Class ReferenceLists.Singleton<K>

java.lang.Object
java.util.AbstractCollection<K>
it.unimi.dsi.fastutil.objects.AbstractReferenceCollection<K>
it.unimi.dsi.fastutil.objects.AbstractReferenceList<K>
it.unimi.dsi.fastutil.objects.ReferenceLists.Singleton<K>
All Implemented Interfaces:
it.unimi.dsi.fastutil.objects.ObjectIterable<K>, ReferenceCollection<K>, ReferenceList<K>, it.unimi.dsi.fastutil.Stack<K>, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<K>, java.util.Collection<K>, java.util.List<K>, java.util.RandomAccess
Enclosing class:
ReferenceLists
public static class ReferenceLists.Singleton<K>
extends AbstractReferenceList<K>
implements java.util.RandomAccess, java.io.Serializable, java.lang.Cloneable
An immutable class representing a type-specific singleton list.

This class may be useful to implement your own in case you subclass a type-specific list.

See Also:
Serialized Form

  • Nested Class Summary

    Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.objects.AbstractReferenceList

    AbstractReferenceList.ReferenceRandomAccessSubList<K>, AbstractReferenceList.ReferenceSubList<K>

  • Method Summary

    Modifier and Type Method Description
    boolean addAll​(int i, java.util.Collection<? extends K> c)
    Adds all of the elements in the specified collection to this list (optional operation).
    boolean addAll​(java.util.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()
    java.lang.Object clone()  
    boolean contains​(java.lang.Object k)
    Returns true if this list contains the specified element.
    void forEach​(java.util.function.Consumer<? super K> action)
    K get​(int i)  
    void getElements​(int from, java.lang.Object[] a, int offset, int length)
    Copies (hopefully quickly) elements of this type-specific list into the given array.
    int indexOf​(java.lang.Object k)  
    it.unimi.dsi.fastutil.objects.ObjectListIterator<K> iterator()
    Returns a type-specific iterator on the elements of this collection.
    it.unimi.dsi.fastutil.objects.ObjectListIterator<K> listIterator()
    Returns a type-specific list iterator on the list.
    it.unimi.dsi.fastutil.objects.ObjectListIterator<K> listIterator​(int i)
    Returns a type-specific list iterator on the list starting at a given index.
    K remove​(int i)
    boolean remove​(java.lang.Object k)  
    boolean removeAll​(java.util.Collection<?> c)  
    void removeElements​(int from, int to)
    Removes (hopefully quickly) elements of this type-specific list.
    boolean removeIf​(java.util.function.Predicate<? super K> filter)  
    void replaceAll​(java.util.function.UnaryOperator<K> operator)  
    boolean retainAll​(java.util.Collection<?> c)  
    void setElements​(int index, K[] a)
    Set (hopefully quickly) elements to match the array given.
    void setElements​(int index, K[] a, int offset, int length)
    Set (hopefully quickly) elements to match the array given.
    void setElements​(K[] a)
    Set (hopefully quickly) elements to match the array given.
    int size()  
    void size​(int size)
    Sets the size of this list.
    void sort​(java.util.Comparator<? super K> comparator)
    Sorts this list using a sort assured to be stable.
    it.unimi.dsi.fastutil.objects.ObjectSpliterator<K> spliterator()
    Returns a type-specific spliterator on the elements 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.
    java.lang.Object[] toArray()  
    void unstableSort​(java.util.Comparator<? super K> comparator)
    Sorts this list using a sort not assured to be stable.

    Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractReferenceList

    add, add, equals, hashCode, lastIndexOf, peek, pop, push, set, toArray, top, toString

    Methods inherited from class java.util.AbstractCollection

    containsAll, isEmpty

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface java.util.Collection

    parallelStream, stream, toArray

    Methods inherited from interface java.util.List

    containsAll, isEmpty

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

    addAll, addAll

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

    isEmpty

  • Method Details

    • get

      public K get​(int i)
      Specified by:
      get in interface java.util.List<K>

    • remove

      public boolean remove​(java.lang.Object k)
      Specified by:
      remove in interface java.util.Collection<K>
      Specified by:
      remove in interface java.util.List<K>
      Overrides:
      remove in class java.util.AbstractCollection<K>

    • remove

      public K remove​(int i)
      Description copied from class: AbstractReferenceList
      Specified by:
      remove in interface java.util.List<K>
      Overrides:
      remove in class AbstractReferenceList<K>

    • contains

      public boolean contains​(java.lang.Object k)
      Description copied from class: AbstractReferenceList
      Returns true if this list contains the specified element.
      Specified by:
      contains in interface java.util.Collection<K>
      Specified by:
      contains in interface java.util.List<K>
      Overrides:
      contains in class AbstractReferenceList<K>
      See Also:
      List.contains(Object)

    • indexOf

      public int indexOf​(java.lang.Object k)
      Specified by:
      indexOf in interface java.util.List<K>
      Overrides:
      indexOf in class AbstractReferenceList<K>

    • toArray

      public java.lang.Object[] toArray()
      Specified by:
      toArray in interface java.util.Collection<K>
      Specified by:
      toArray in interface java.util.List<K>
      Overrides:
      toArray in class AbstractReferenceList<K>

    • listIterator

      public it.unimi.dsi.fastutil.objects.ObjectListIterator<K> listIterator()
      Description copied from class: AbstractReferenceList
      Returns a type-specific list iterator on the list.
      Specified by:
      listIterator in interface java.util.List<K>
      Specified by:
      listIterator in interface ReferenceList<K>
      Overrides:
      listIterator in class AbstractReferenceList<K>
      See Also:
      List.listIterator()

    • iterator

      public it.unimi.dsi.fastutil.objects.ObjectListIterator<K> iterator()
      Description copied from class: AbstractReferenceList
      Returns a type-specific iterator on the elements of this collection.
      Specified by:
      iterator in interface java.util.Collection<K>
      Specified by:
      iterator in interface java.lang.Iterable<K>
      Specified by:
      iterator in interface java.util.List<K>
      Specified by:
      iterator in interface it.unimi.dsi.fastutil.objects.ObjectIterable<K>
      Specified by:
      iterator in interface ReferenceCollection<K>
      Specified by:
      iterator in interface ReferenceList<K>
      Overrides:
      iterator in class AbstractReferenceList<K>
      Returns:
      a type-specific iterator on the elements of this collection.

    • spliterator

      public it.unimi.dsi.fastutil.objects.ObjectSpliterator<K> spliterator()
      Description copied from interface: ReferenceList
      Returns a type-specific spliterator on the elements of this list.

      List spliterators must report at least Spliterator.SIZED and Spliterator.ORDERED.

      See List.spliterator() for more documentation on the requirements of the returned spliterator.

      Specified by:
      spliterator in interface java.util.Collection<K>
      Specified by:
      spliterator in interface java.lang.Iterable<K>
      Specified by:
      spliterator in interface java.util.List<K>
      Specified by:
      spliterator in interface it.unimi.dsi.fastutil.objects.ObjectIterable<K>
      Specified by:
      spliterator in interface ReferenceCollection<K>
      Specified by:
      spliterator in interface ReferenceList<K>
      Returns:
      a type-specific spliterator on the elements of this collection.

    • listIterator

      public it.unimi.dsi.fastutil.objects.ObjectListIterator<K> listIterator​(int i)
      Description copied from class: AbstractReferenceList
      Returns a type-specific list iterator on the list starting at a given index.
      Specified by:
      listIterator in interface java.util.List<K>
      Specified by:
      listIterator in interface ReferenceList<K>
      Overrides:
      listIterator in class AbstractReferenceList<K>
      See Also:
      List.listIterator(int)

    • 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.
      Specified by:
      subList in interface java.util.List<K>
      Specified by:
      subList in interface ReferenceList<K>
      Overrides:
      subList in class AbstractReferenceList<K>
      See Also:
      List.subList(int,int)

    • forEach

      public void forEach​(java.util.function.Consumer<? super K> action)
      Description copied from class: AbstractReferenceList
      Specified by:
      forEach in interface java.lang.Iterable<K>
      Overrides:
      forEach in class AbstractReferenceList<K>

    • addAll

      public boolean addAll​(int i, java.util.Collection<? extends K> c)
      Description copied from class: AbstractReferenceList
      Adds all of the elements in the specified collection to this list (optional operation).
      Specified by:
      addAll in interface java.util.List<K>
      Overrides:
      addAll in class AbstractReferenceList<K>

    • addAll

      public boolean addAll​(java.util.Collection<? extends K> c)
      Description copied from class: AbstractReferenceList
      Specified by:
      addAll in interface java.util.Collection<K>
      Specified by:
      addAll in interface java.util.List<K>
      Overrides:
      addAll in class AbstractReferenceList<K>

    • removeAll

      public boolean removeAll​(java.util.Collection<?> c)
      Specified by:
      removeAll in interface java.util.Collection<K>
      Specified by:
      removeAll in interface java.util.List<K>
      Overrides:
      removeAll in class java.util.AbstractCollection<K>

    • retainAll

      public boolean retainAll​(java.util.Collection<?> c)
      Specified by:
      retainAll in interface java.util.Collection<K>
      Specified by:
      retainAll in interface java.util.List<K>
      Overrides:
      retainAll in class java.util.AbstractCollection<K>

    • removeIf

      public boolean removeIf​(java.util.function.Predicate<? super K> filter)
      Specified by:
      removeIf in interface java.util.Collection<K>

    • replaceAll

      public void replaceAll​(java.util.function.UnaryOperator<K> operator)
      Specified by:
      replaceAll in interface java.util.List<K>

    • sort

      public void sort​(java.util.Comparator<? super K> comparator)
      Description copied from interface: ReferenceList
      Sorts this list using a sort assured to be stable.

      Pass null to sort using natural ordering.

      Unless a subclass specifies otherwise, the results of the method if the list is concurrently modified during the sort are unspecified.

      Specified by:
      sort in interface java.util.List<K>
      Specified by:
      sort in interface ReferenceList<K>

    • unstableSort

      public void unstableSort​(java.util.Comparator<? super K> comparator)
      Description copied from interface: ReferenceList
      Sorts this list using a sort not assured to be stable. This differs from List.sort(java.util.Comparator) in that the results are not assured to be stable, but may be a bit faster.

      Pass null to sort using natural ordering.

      Unless a subclass specifies otherwise, the results of the method if the list is concurrently modified during the sort are unspecified.

      Specified by:
      unstableSort in interface ReferenceList<K>

    • getElements

      public void getElements​(int from, java.lang.Object[] a, int offset, int length)
      Description copied from class: AbstractReferenceList
      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>
      Overrides:
      getElements in class AbstractReferenceList<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.

    • removeElements

      public void removeElements​(int from, int to)
      Description copied from class: AbstractReferenceList
      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 ReferenceList<K>
      Overrides:
      removeElements in class AbstractReferenceList<K>
      Parameters:
      from - the start index (inclusive).
      to - the end index (exclusive).

    • addElements

      public void addElements​(int index, K[] a)
      Description copied from class: AbstractReferenceList
      Add (hopefully quickly) elements to this type-specific list.
      Specified by:
      addElements in interface ReferenceList<K>
      Overrides:
      addElements in class AbstractReferenceList<K>
      Parameters:
      index - the index at which to add elements.
      a - the array containing the elements.

    • addElements

      public void addElements​(int index, K[] a, int offset, int length)
      Description copied from class: AbstractReferenceList
      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>
      Overrides:
      addElements in class AbstractReferenceList<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.

    • setElements

      public void setElements​(K[] a)
      Description copied from interface: ReferenceList
      Set (hopefully quickly) elements to match the array given.
      Specified by:
      setElements in interface ReferenceList<K>
      Parameters:
      a - the array containing the elements.

    • setElements

      public void setElements​(int index, K[] a)
      Description copied from interface: ReferenceList
      Set (hopefully quickly) elements to match the array given.
      Specified by:
      setElements in interface ReferenceList<K>
      Parameters:
      index - the index at which to start setting elements.
      a - the array containing the elements.

    • setElements

      public void setElements​(int index, K[] a, int offset, int length)
      Description copied from interface: ReferenceList
      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 ReferenceList<K>
      Overrides:
      setElements in class AbstractReferenceList<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.

    • size

      public int size()
      Specified by:
      size in interface java.util.Collection<K>
      Specified by:
      size in interface java.util.List<K>
      Specified by:
      size in class java.util.AbstractCollection<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>
      Overrides:
      size in class AbstractReferenceList<K>
      Parameters:
      size - the new size.

    • clear

      public void clear()
      Description copied from class: AbstractReferenceList
      Specified by:
      clear in interface java.util.Collection<K>
      Specified by:
      clear in interface java.util.List<K>
      Overrides:
      clear in class AbstractReferenceList<K>

    • clone

      public java.lang.Object clone()