Class CharLists.Singleton

  • 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
    Enclosing class:
    CharLists

    public static class CharLists.Singleton
    extends AbstractCharList
    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
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean addAll​(int i, CharCollection 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 i, CharList c)
      Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).
      boolean addAll​(int i, java.util.Collection<? extends java.lang.Character> c)
      Adds all of the elements in the specified collection to this list (optional operation).
      boolean addAll​(CharCollection c)
      Adds all elements of the given type-specific collection to this collection.
      boolean addAll​(CharList c)
      Appends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).
      boolean addAll​(java.util.Collection<? extends java.lang.Character> c)
      void addElements​(int index, char[] a)
      Add (hopefully quickly) elements to this type-specific list.
      void addElements​(int index, char[] a, int offset, int length)
      Add (hopefully quickly) elements to this type-specific list.
      void clear()
      java.lang.Object clone()  
      boolean contains​(char k)
      Returns true if this list contains the specified element.
      void forEach​(CharConsumer 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 forEach​(java.util.function.Consumer<? super java.lang.Character> action)
      Deprecated.
      char getChar​(int i)
      Returns the element at the specified position in this list.
      void getElements​(int from, char[] a, int offset, int length)
      Copies (hopefully quickly) elements of this type-specific list into the given array.
      int indexOf​(char 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.
      IntIterator intIterator()
      Returns a widened primitive iterator on the elements of this collection.
      IntSpliterator intSpliterator()
      Returns widened primitive spliterator on the elements of this collection.
      CharListIterator iterator()
      Returns a type-specific iterator on the elements of this collection.
      CharListIterator listIterator()
      Returns a type-specific list iterator on the list.
      CharListIterator listIterator​(int i)
      Returns a type-specific list iterator on the list starting at a given index.
      boolean rem​(char k)
      Removes a single instance of the specified element from this collection, if it is present (optional operation).
      boolean removeAll​(CharCollection c)
      Remove from this collection all elements in the given type-specific collection.
      boolean removeAll​(java.util.Collection<?> c)
      char removeChar​(int i)
      Removes the element at the specified position in this list (optional operation).
      void removeElements​(int from, int to)
      Removes (hopefully quickly) elements of this type-specific list.
      boolean removeIf​(CharPredicate filter)
      Remove from this collection all elements which satisfy the given predicate.
      boolean removeIf​(java.util.function.Predicate<? super java.lang.Character> filter)
      Deprecated.
      void replaceAll​(CharUnaryOperator operator)
      Replaces each element of this list with the result of applying the operator to that element.
      void replaceAll​(java.util.function.UnaryOperator<java.lang.Character> operator)
      Deprecated.
      boolean retainAll​(CharCollection c)
      Retains in this collection only elements from the given type-specific collection.
      boolean retainAll​(java.util.Collection<?> c)
      void setElements​(char[] a)
      Set (hopefully quickly) elements to match the array given.
      void setElements​(int index, char[] a)
      Set (hopefully quickly) elements to match the array given.
      void setElements​(int index, char[] a, int offset, int length)
      Set (hopefully quickly) elements to match the array given.
      int size()  
      void size​(int size)
      Sets the size of this list.
      void sort​(CharComparator comparator)
      Sort a list using a type-specific comparator.
      void sort​(java.util.Comparator<? super java.lang.Character> comparator)
      Deprecated.
      CharSpliterator spliterator()
      Returns a type-specific spliterator on the elements of this list.
      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.
      java.lang.Object[] toArray()
      Deprecated.
      char[] toCharArray()
      Returns a primitive type array containing the items of this collection.
      void unstableSort​(CharComparator comparator)
      Sorts this list using a sort not assured to be stable.
      void unstableSort​(java.util.Comparator<? super java.lang.Character> comparator)
      Deprecated.
      • Methods inherited from class java.util.AbstractCollection

        isEmpty, 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, toArray
      • Methods inherited from interface it.unimi.dsi.fastutil.Stack

        isEmpty
    • Method Detail

      • getChar

        public char getChar​(int i)
        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)
      • rem

        public boolean rem​(char k)
        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)
      • removeChar

        public char removeChar​(int i)
        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)
      • 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)
      • 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()
      • iterator

        public CharListIterator iterator()
        Description copied from class: AbstractCharList
        Returns a type-specific iterator on the elements of this collection.
        Specified by:
        iterator in interface CharCollection
        Specified by:
        iterator in interface CharIterable
        Specified by:
        iterator in interface CharList
        Specified by:
        iterator in interface java.util.Collection<java.lang.Character>
        Specified by:
        iterator in interface java.lang.Iterable<java.lang.Character>
        Specified by:
        iterator in interface java.util.List<java.lang.Character>
        Overrides:
        iterator in class AbstractCharList
        Returns:
        a type-specific iterator on the elements of this collection.
        See Also:
        Iterable.iterator()
      • 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.
      • listIterator

        public CharListIterator listIterator​(int i)
        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)
      • subList

        public CharList subList​(int from,
                                int to)
        Description copied from interface: CharList
        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)
      • forEach

        @Deprecated
        public void forEach​(java.util.function.Consumer<? super java.lang.Character> action)
        Deprecated.
        Description copied from interface: CharIterable
        Specified by:
        forEach in interface CharIterable
        Specified by:
        forEach in interface java.lang.Iterable<java.lang.Character>
      • addAll

        public boolean addAll​(int i,
                              java.util.Collection<? extends java.lang.Character> c)
        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
      • addAll

        public boolean addAll​(java.util.Collection<? extends java.lang.Character> c)
        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
      • removeAll

        public boolean removeAll​(java.util.Collection<?> c)
        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
      • retainAll

        public boolean retainAll​(java.util.Collection<?> c)
        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
      • removeIf

        @Deprecated
        public boolean removeIf​(java.util.function.Predicate<? super java.lang.Character> filter)
        Deprecated.
        Description copied from interface: CharCollection
        Specified by:
        removeIf in interface CharCollection
        Specified by:
        removeIf in interface java.util.Collection<java.lang.Character>
      • replaceAll

        @Deprecated
        public 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>
      • replaceAll

        public void replaceAll​(CharUnaryOperator operator)
        Description copied from interface: CharList
        Replaces each element of this list with the result of applying the operator to that element.
        Specified by:
        replaceAll in interface CharList
        Parameters:
        operator - the operator to apply to each element.
        See Also:
        List.replaceAll(java.util.function.UnaryOperator<E>)
      • 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)
      • addAll

        public boolean addAll​(CharList c)
        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)
      • addAll

        public boolean addAll​(int i,
                              CharList c)
        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)
      • addAll

        public boolean addAll​(int i,
                              CharCollection c)
        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)
      • addAll

        public boolean addAll​(CharCollection c)
        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)
      • removeAll

        public boolean removeAll​(CharCollection c)
        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)
      • retainAll

        public boolean retainAll​(CharCollection c)
        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)
      • removeIf

        public boolean removeIf​(CharPredicate filter)
        Description copied from interface: CharCollection
        Remove from this collection all elements which satisfy the given predicate.
        Specified by:
        removeIf in interface CharCollection
        Parameters:
        filter - 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)
      • intIterator

        public IntIterator intIterator()
        Description copied from interface: CharCollection
        Returns a widened primitive iterator on the elements of this collection.

        This method is provided for the purpose of APIs that expect only the JDK's primitive iterators, of which there are only int, long, and double.

        WARNING: This is not the same as converting the source to a sequence of code points. This returned instance literally performs (int)(charValue) casts. Surrogate pairs will be left as separate elements instead of combined into a single element with the code point it represents. See Character for more discussion on code points, char values, and surrogate pairs.

        Specified by:
        intIterator in interface CharCollection
        Specified by:
        intIterator in interface CharIterable
        Returns:
        a widened primitive iterator on the elements of this collection.
      • intSpliterator

        public IntSpliterator intSpliterator()
        Description copied from interface: CharCollection
        Returns widened primitive spliterator on the elements of this collection.

        This method is provided for the purpose of APIs that expect only the JDK's primitive spliterators, of which there are only int, long, and double.

        WARNING: This is not the same as converting the source to a sequence of code points. This returned instance literally performs (int)(charValue) casts. Surrogate pairs will be left as separate elements instead of combined into a single element with the code point it represents. See Character for more discussion on code points, char values, and surrogate pairs.

        Specified by:
        intSpliterator in interface CharCollection
        Specified by:
        intSpliterator in interface CharIterable
        Returns:
        a widened primitive spliterator on the elements of this collection.
      • toArray

        @Deprecated
        public java.lang.Object[] toArray()
        Deprecated.
        Specified by:
        toArray in interface java.util.Collection<java.lang.Character>
        Specified by:
        toArray in interface java.util.List<java.lang.Character>
        Overrides:
        toArray in class java.util.AbstractCollection<java.lang.Character>
      • sort

        public void sort​(CharComparator comparator)
        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)
      • unstableSort

        public void unstableSort​(CharComparator comparator)
        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
      • sort

        @Deprecated
        public 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>
      • unstableSort

        @Deprecated
        public 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
      • getElements

        public void getElements​(int from,
                                char[] a,
                                int offset,
                                int length)
        Description copied from class: AbstractCharList
        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 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.
      • removeElements

        public void removeElements​(int from,
                                   int to)
        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).
      • addElements

        public void addElements​(int index,
                                char[] a)
        Description copied from class: AbstractCharList
        Add (hopefully quickly) elements to this type-specific list.
        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.
      • addElements

        public void addElements​(int index,
                                char[] a,
                                int offset,
                                int length)
        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.
      • setElements

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

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

        public void setElements​(int index,
                                char[] a,
                                int offset,
                                int length)
        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.
      • 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>
      • size

        public void size​(int size)
        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.
      • clear

        public void clear()
        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
      • clone

        public java.lang.Object clone()