Package it.unimi.dsi.fastutil.chars

Class CharImmutableList

java.lang.Object
java.util.AbstractCollection<java.lang.Character>
it.unimi.dsi.fastutil.chars.AbstractCharCollection
it.unimi.dsi.fastutil.chars.AbstractCharList
it.unimi.dsi.fastutil.chars.CharImmutableList
All Implemented Interfaces:
CharCollection, CharIterable, CharList, CharStack, Stack<java.lang.Character>, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<java.util.List<? extends java.lang.Character>>, java.lang.Iterable<java.lang.Character>, java.util.Collection<java.lang.Character>, java.util.List<java.lang.Character>, java.util.RandomAccess
public class CharImmutableList
extends AbstractCharList
implements CharList, java.util.RandomAccess, java.lang.Cloneable, java.io.Serializable
A type-specific array-based immutable list; provides some additional methods that use polymorphism to avoid (un)boxing.

Instances of this class are immutable and (contrarily to mutable array-based list implementations) the backing array is not exposed. Instances can be built using a variety of methods, but note that constructors using an array will not make a defensive copy.

This class implements the bulk method getElements() using high-performance system calls (e.g., System.arraycopy()) instead of expensive loops.

See Also:
Serialized Form

  • Constructor Details

    • CharImmutableList

      public CharImmutableList​(char[] a)
      Creates a new immutable list using a given array.

      Note that this constructor does not perform a defensive copy.

      Parameters:
      a - the array that will be used to back this immutable list.

    • CharImmutableList

      public CharImmutableList​(java.util.Collection<? extends java.lang.Character> c)
      Creates a new immutable list and fills it with a given collection.
      Parameters:
      c - a collection that will be used to fill the immutable list.

    • CharImmutableList

      public CharImmutableList​(CharCollection c)
      Creates a new immutable list and fills it with a given type-specific collection.
      Parameters:
      c - a type-specific collection that will be used to fill the immutable list.

    • CharImmutableList

      public CharImmutableList​(CharList l)
      Creates a new immutable list and fills it with a given type-specific list.
      Parameters:
      l - a type-specific list that will be used to fill the immutable list.

    • CharImmutableList

      public CharImmutableList​(char[] a, int offset, int length)
      Creates a new immutable list and fills it with the elements of a given array.
      Parameters:
      a - an array whose elements will be used to fill the immutable list.
      offset - the first element to use.
      length - the number of elements to use.

    • CharImmutableList

      public CharImmutableList​(CharIterator i)
      Creates a new immutable list and fills it with the elements returned by a type-specific iterator..
      Parameters:
      i - a type-specific iterator whose returned elements will fill the immutable list.

  • Method Details

    • of

      public static CharImmutableList of()
      Returns an empty immutable list.
      Returns:
      an immutable list (possibly shared) that is empty.

    • of

      public static CharImmutableList of​(char... init)
      Creates an immutable list using a list of elements.

      Note that this method does not perform a defensive copy.

      Parameters:
      init - a list of elements that will be used to initialize the list.
      Returns:
      a new immutable list containing the given elements.

    • getChar

      public char getChar​(int index)
      Description copied from interface: CharList
      Returns the element at the specified position in this list.
      Specified by:
      getChar in interface CharList
      See Also:
      List.get(int)

    • indexOf

      public int indexOf​(char k)
      Description copied from interface: CharList
      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 CharList
      Overrides:
      indexOf in class AbstractCharList
      See Also:
      List.indexOf(Object)

    • lastIndexOf

      public int lastIndexOf​(char k)
      Description copied from interface: CharList
      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 CharList
      Overrides:
      lastIndexOf in class AbstractCharList
      See Also:
      List.lastIndexOf(Object)

    • size

      public int size()
      Specified by:
      size in interface java.util.Collection<java.lang.Character>
      Specified by:
      size in interface java.util.List<java.lang.Character>
      Specified by:
      size in class java.util.AbstractCollection<java.lang.Character>

    • isEmpty

      public boolean isEmpty()
      Description copied from interface: Stack
      Checks whether the stack is empty.
      Specified by:
      isEmpty in interface java.util.Collection<java.lang.Character>
      Specified by:
      isEmpty in interface java.util.List<java.lang.Character>
      Specified by:
      isEmpty in interface Stack<java.lang.Character>
      Overrides:
      isEmpty in class java.util.AbstractCollection<java.lang.Character>
      Returns:
      true if the stack is empty.

    • getElements

      public void getElements​(int from, char[] a, int offset, int length)
      Copies element of this type-specific list into the given array using optimized system calls.
      Specified by:
      getElements in interface CharList
      Overrides:
      getElements in class AbstractCharList
      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.

    • forEach

      public void forEach​(CharConsumer action)
      Description copied from class: AbstractCharList
      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 CharIterable
      Overrides:
      forEach in class AbstractCharList
      Parameters:
      action - the action to be performed for each element.
      See Also:
      Iterable.forEach(java.util.function.Consumer)

    • toCharArray

      public char[] toCharArray()
      Description copied from interface: CharCollection
      Returns a primitive type array containing the items of this collection.
      Specified by:
      toCharArray in interface CharCollection
      Overrides:
      toCharArray in class AbstractCharList
      Returns:
      a primitive type array containing the items of this collection.
      See Also:
      Collection.toArray()

    • toArray

      public char[] toArray​(char[] a)
      Description copied from interface: CharCollection
      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 CharCollection
      Overrides:
      toArray in class AbstractCharList
      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[])

    • listIterator

      public CharListIterator listIterator​(int index)
      Description copied from class: AbstractCharList
      Returns a type-specific list iterator on the list starting at a given index.
      Specified by:
      listIterator in interface CharList
      Specified by:
      listIterator in interface java.util.List<java.lang.Character>
      Overrides:
      listIterator in class AbstractCharList
      See Also:
      List.listIterator(int)

    • spliterator

      public CharSpliterator spliterator()
      Description copied from interface: CharList
      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 CharCollection
      Specified by:
      spliterator in interface CharIterable
      Specified by:
      spliterator in interface CharList
      Specified by:
      spliterator in interface java.util.Collection<java.lang.Character>
      Specified by:
      spliterator in interface java.lang.Iterable<java.lang.Character>
      Specified by:
      spliterator in interface java.util.List<java.lang.Character>
      Returns:
      a type-specific spliterator on the elements of this collection.

    • subList

      public CharList 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.
      Specified by:
      subList in interface CharList
      Specified by:
      subList in interface java.util.List<java.lang.Character>
      Overrides:
      subList in class AbstractCharList
      See Also:
      List.subList(int,int)
      API Notes:
      The returned list will be immutable, but is currently not declared to return an instance of ImmutableList due to complications of implementation details. This may change in a future version (in other words, do not consider the return type of this method to be stable if making a subclass of ImmutableList).

    • clone

      public CharImmutableList clone()

    • equals

      public boolean equals​(CharImmutableList l)
      Compares this type-specific immutable list to another one.
      Parameters:
      l - a type-specific immutable list.
      Returns:
      true if the argument contains the same elements of this type-specific immutable list.
      API Notes:
      This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.

    • equals

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

    • compareTo

      public int compareTo​(CharImmutableList l)
      Compares this immutable list to another immutable list.
      Parameters:
      l - an immutable list.
      Returns:
      a negative integer, zero, or a positive integer as this list is lexicographically less than, equal to, or greater than the argument.
      API Notes:
      This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.

    • compareTo

      public int compareTo​(java.util.List<? extends java.lang.Character> l)
      Description copied from class: AbstractCharList
      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.Character>>
      Overrides:
      compareTo in class AbstractCharList
      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.

    • add

      @Deprecated public final void add​(int index, char k)
      Deprecated.
      Description copied from class: AbstractCharList
      Inserts the specified element at the specified position in this list (optional operation).
      Specified by:
      add in interface CharList
      Overrides:
      add in class AbstractCharList
      See Also:
      List.add(int,Object)
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • add

      @Deprecated public final boolean add​(char k)
      Deprecated.
      Description copied from class: AbstractCharList
      Ensures that this collection contains the specified element (optional operation).
      Specified by:
      add in interface CharCollection
      Specified by:
      add in interface CharList
      Overrides:
      add in class AbstractCharList
      See Also:
      Collection.add(Object)
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • addAll

      @Deprecated public final boolean addAll​(java.util.Collection<? extends java.lang.Character> c)
      Deprecated.
      Description copied from class: AbstractCharList
      Specified by:
      addAll in interface java.util.Collection<java.lang.Character>
      Specified by:
      addAll in interface java.util.List<java.lang.Character>
      Overrides:
      addAll in class AbstractCharList
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • addAll

      @Deprecated public final boolean addAll​(int index, java.util.Collection<? extends java.lang.Character> c)
      Deprecated.
      Description copied from class: AbstractCharList
      Adds all of the elements in the specified collection to this list (optional operation).
      Specified by:
      addAll in interface java.util.List<java.lang.Character>
      Overrides:
      addAll in class AbstractCharList
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • removeChar

      @Deprecated public final char removeChar​(int index)
      Deprecated.
      Description copied from class: AbstractCharList
      Removes the element at the specified position in this list (optional operation).
      Specified by:
      removeChar in interface CharList
      Overrides:
      removeChar in class AbstractCharList
      See Also:
      List.remove(int)
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • rem

      @Deprecated public final boolean rem​(char k)
      Deprecated.
      Description copied from class: AbstractCharList
      Removes a single instance of the specified element from this collection, if it is present (optional operation).
      Specified by:
      rem in interface CharCollection
      Overrides:
      rem in class AbstractCharList
      See Also:
      List.remove(Object)
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • removeAll

      @Deprecated public final boolean removeAll​(java.util.Collection<?> c)
      Deprecated.
      Description copied from class: AbstractCharCollection
      Specified by:
      removeAll in interface java.util.Collection<java.lang.Character>
      Specified by:
      removeAll in interface java.util.List<java.lang.Character>
      Overrides:
      removeAll in class AbstractCharCollection
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • retainAll

      @Deprecated public final boolean retainAll​(java.util.Collection<?> c)
      Deprecated.
      Description copied from class: AbstractCharCollection
      Specified by:
      retainAll in interface java.util.Collection<java.lang.Character>
      Specified by:
      retainAll in interface java.util.List<java.lang.Character>
      Overrides:
      retainAll in class AbstractCharCollection
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • removeIf

      @Deprecated public final boolean removeIf​(java.util.function.Predicate<? super java.lang.Character> c)
      Deprecated.
      Description copied from interface: CharCollection
      Specified by:
      removeIf in interface CharCollection
      Specified by:
      removeIf in interface java.util.Collection<java.lang.Character>
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • removeIf

      @Deprecated public final boolean removeIf​(CharPredicate c)
      Deprecated.
      Description copied from interface: CharCollection
      Remove from this collection all elements which satisfy the given predicate.
      Specified by:
      removeIf in interface CharCollection
      Parameters:
      c - a predicate which returns true for elements to be removed.
      Returns:
      true if any elements were removed.
      See Also:
      Collection.removeIf(java.util.function.Predicate)
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • replaceAll

      @Deprecated public final void replaceAll​(java.util.function.UnaryOperator<java.lang.Character> operator)
      Deprecated.
      Description copied from interface: CharList
      Specified by:
      replaceAll in interface CharList
      Specified by:
      replaceAll in interface java.util.List<java.lang.Character>
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • replaceAll

      @Deprecated public final void replaceAll​(java.util.function.IntUnaryOperator operator)
      Deprecated.
      Description copied from interface: CharList
      Replaces each element of this list with the result of applying the operator to that element, performing widening and narrowing primitive casts, until all elements have been processed or the action throws an exception.
      Specified by:
      replaceAll in interface CharList
      Parameters:
      operator - the operator to apply to each element
      See Also:
      List.replaceAll(java.util.function.UnaryOperator<E>)
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • add

      @Deprecated public final void add​(int index, java.lang.Character k)
      Deprecated.
      Description copied from interface: CharList
      Specified by:
      add in interface CharList
      Specified by:
      add in interface java.util.List<java.lang.Character>
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • add

      @Deprecated public final boolean add​(java.lang.Character k)
      Deprecated.
      Description copied from class: AbstractCharCollection
      Specified by:
      add in interface CharCollection
      Specified by:
      add in interface CharList
      Specified by:
      add in interface java.util.Collection<java.lang.Character>
      Specified by:
      add in interface java.util.List<java.lang.Character>
      Overrides:
      add in class AbstractCharCollection
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • remove

      @Deprecated public final java.lang.Character remove​(int index)
      Deprecated.
      Description copied from interface: CharList
      Specified by:
      remove in interface CharList
      Specified by:
      remove in interface java.util.List<java.lang.Character>
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • remove

      @Deprecated public final boolean remove​(java.lang.Object k)
      Deprecated.
      Description copied from class: AbstractCharCollection
      Specified by:
      remove in interface CharCollection
      Specified by:
      remove in interface CharList
      Specified by:
      remove in interface java.util.Collection<java.lang.Character>
      Specified by:
      remove in interface java.util.List<java.lang.Character>
      Overrides:
      remove in class AbstractCharCollection
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • set

      @Deprecated public final java.lang.Character set​(int index, java.lang.Character k)
      Deprecated.
      Description copied from interface: CharList
      Specified by:
      set in interface CharList
      Specified by:
      set in interface java.util.List<java.lang.Character>
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • addAll

      @Deprecated public final boolean addAll​(CharCollection c)
      Deprecated.
      Description copied from class: AbstractCharList
      Adds all elements of the given type-specific collection to this collection.
      Specified by:
      addAll in interface CharCollection
      Overrides:
      addAll in class AbstractCharList
      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:
      Always throws UnsupportedOperationException as this is an immutable type.

    • addAll

      @Deprecated public final boolean addAll​(CharList c)
      Deprecated.
      Description copied from interface: CharList
      Appends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).
      Specified by:
      addAll in interface CharList
      See Also:
      List.addAll(Collection)
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • addAll

      @Deprecated public final boolean addAll​(int index, CharCollection c)
      Deprecated.
      Description copied from interface: CharList
      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 CharList
      Overrides:
      addAll in class AbstractCharList
      See Also:
      List.addAll(int,java.util.Collection)
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • addAll

      @Deprecated public final boolean addAll​(int index, CharList c)
      Deprecated.
      Description copied from interface: CharList
      Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).
      Specified by:
      addAll in interface CharList
      See Also:
      List.addAll(int,Collection)
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • removeAll

      @Deprecated public final boolean removeAll​(CharCollection c)
      Deprecated.
      Description copied from interface: CharCollection
      Remove from this collection all elements in the given type-specific collection.
      Specified by:
      removeAll in interface CharCollection
      Overrides:
      removeAll in class AbstractCharCollection
      Parameters:
      c - a type-specific collection.
      Returns:
      true if this collection changed as a result of the call.
      See Also:
      Collection.removeAll(Collection)
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • retainAll

      @Deprecated public final boolean retainAll​(CharCollection c)
      Deprecated.
      Description copied from interface: CharCollection
      Retains in this collection only elements from the given type-specific collection.
      Specified by:
      retainAll in interface CharCollection
      Overrides:
      retainAll in class AbstractCharCollection
      Parameters:
      c - a type-specific collection.
      Returns:
      true if this collection changed as a result of the call.
      See Also:
      Collection.retainAll(Collection)
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • set

      @Deprecated public final char set​(int index, char k)
      Deprecated.
      Description copied from class: AbstractCharList
      Replaces the element at the specified position in this list with the specified element (optional operation).
      Specified by:
      set in interface CharList
      Overrides:
      set in class AbstractCharList
      See Also:
      List.set(int,Object)
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • clear

      @Deprecated public final void clear()
      Deprecated.
      Description copied from class: AbstractCharList
      Specified by:
      clear in interface java.util.Collection<java.lang.Character>
      Specified by:
      clear in interface java.util.List<java.lang.Character>
      Overrides:
      clear in class AbstractCharList
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • size

      @Deprecated public final void size​(int size)
      Deprecated.
      Description copied from interface: CharList
      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 CharList
      Overrides:
      size in class AbstractCharList
      Parameters:
      size - the new size.
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • removeElements

      @Deprecated public final void removeElements​(int from, int to)
      Deprecated.
      Description copied from class: AbstractCharList
      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 CharList
      Overrides:
      removeElements in class AbstractCharList
      Parameters:
      from - the start index (inclusive).
      to - the end index (exclusive).
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • addElements

      @Deprecated public final void addElements​(int index, char[] a, int offset, int length)
      Deprecated.
      Description copied from class: AbstractCharList
      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 CharList
      Overrides:
      addElements in class AbstractCharList
      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.
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • setElements

      @Deprecated public final void setElements​(int index, char[] a, int offset, int length)
      Deprecated.
      Description copied from interface: CharList
      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 CharList
      Overrides:
      setElements in class AbstractCharList
      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.
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • sort

      @Deprecated public final void sort​(CharComparator comp)
      Deprecated.
      Description copied from interface: CharList
      Sort a list using a type-specific comparator.

      Pass null to sort using natural ordering.

      Specified by:
      sort in interface CharList
      See Also:
      List.sort(java.util.Comparator)
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • unstableSort

      @Deprecated public final void unstableSort​(CharComparator comp)
      Deprecated.
      Description copied from interface: CharList
      Sorts this list using a sort not assured to be stable.

      Pass null to sort using natural ordering.

      This differs from List.sort(java.util.Comparator) in that the results are not assured to be stable, but may be a bit faster.

      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 CharList
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • sort

      @Deprecated public final void sort​(java.util.Comparator<? super java.lang.Character> comparator)
      Deprecated.
      Description copied from interface: CharList
      Specified by:
      sort in interface CharList
      Specified by:
      sort in interface java.util.List<java.lang.Character>
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.

    • unstableSort

      @Deprecated public final void unstableSort​(java.util.Comparator<? super java.lang.Character> comparator)
      Deprecated.
      Description copied from interface: CharList
      Sorts this list using a sort not assured to be stable.
      Specified by:
      unstableSort in interface CharList
      Implementation Specification:
      Always throws UnsupportedOperationException as this is an immutable type.