Package it.unimi.dsi.fastutil.chars

Interface CharCollection

All Superinterfaces:
CharIterable, Collection<Character>, Iterable<Character>
All Known Subinterfaces:
CharBigList, CharList, CharSet, CharSortedSet
All Known Implementing Classes:
AbstractCharBigList, AbstractCharBigList.CharRandomAccessSubList, AbstractCharBigList.CharSubList, AbstractCharCollection, AbstractCharList, AbstractCharList.CharRandomAccessSubList, AbstractCharList.CharSubList, AbstractCharSet, AbstractCharSortedSet, CharArrayList, CharArraySet, CharAVLTreeSet, CharBigArrayBigList, CharBigLists.EmptyBigList, CharBigLists.ListBigList, CharBigLists.Singleton, CharBigLists.SynchronizedBigList, CharBigLists.UnmodifiableBigList, CharCollections.EmptyCollection, CharCollections.IterableCollection, CharImmutableList, CharLinkedOpenCustomHashSet, CharLinkedOpenHashSet, CharLists.EmptyList, CharLists.Singleton, CharLists.SynchronizedList, CharLists.SynchronizedRandomAccessList, CharLists.UnmodifiableList, CharLists.UnmodifiableRandomAccessList, CharMappedBigList, CharOpenCustomHashSet, CharOpenHashSet, CharRBTreeSet, CharSets.EmptySet, CharSets.Singleton, CharSets.SynchronizedSet, CharSets.UnmodifiableSet, CharSortedSets.EmptySet, CharSortedSets.Singleton, CharSortedSets.SynchronizedSortedSet, CharSortedSets.UnmodifiableSortedSet
public interface CharCollection extends Collection<Character>, CharIterable
A type-specific Collection; provides some additional methods that use polymorphism to avoid (un)boxing.

Additionally, this class defines strengthens (again) iterator().

This interface specifies reference equality semantics (members will be compared equal with == instead of equals), which may result in breaks in contract if attempted to be used with non reference-equality semantics based Collections. For example, a aReferenceCollection.equals(aObjectCollection) may return different a different result then aObjectCollection.equals(aReferenceCollection), in violation of equals's contract requiring it being symmetric.

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    add(char key)
    Ensures that this collection contains the specified element (optional operation).
    default boolean
    add(Character key)
    Deprecated.
    Please use the corresponding type-specific method instead.
    boolean
    addAll(CharCollection c)
    Adds all elements of the given type-specific collection to this collection.
    boolean
    contains(char key)
    Returns true if this collection contains the specified element.
    default boolean
    contains(Object key)
    Deprecated.
    Please use the corresponding type-specific method instead.
    boolean
    containsAll(CharCollection c)
    Checks whether this collection contains all elements from the given type-specific collection.
    default IntIterator
    intIterator()
    Returns a widened primitive iterator on the elements of this collection.
    default IntStream
    intParallelStream()
    Return a parallel primitive stream over the elements, performing widening casts if needed.
    default IntSpliterator
    intSpliterator()
    Returns widened primitive spliterator on the elements of this collection.
    default IntStream
    intStream()
    Return a primitive stream over the elements, performing widening casts if needed.
    CharIterator
    iterator()
    Returns a type-specific iterator on the elements of this collection.
    default Stream<Character>
    parallelStream()
    Deprecated.
    Please use the corresponding type-specific method instead.
    boolean
    rem(char key)
    Removes a single instance of the specified element from this collection, if it is present (optional operation).
    default boolean
    remove(Object key)
    Deprecated.
    Please use (and implement) the rem() method instead.
    boolean
    removeAll(CharCollection c)
    Remove from this collection all elements in the given type-specific collection.
    default boolean
    removeIf(CharPredicate filter)
    Remove from this collection all elements which satisfy the given predicate.
    default boolean
    removeIf(IntPredicate filter)
    Remove from this collection all elements which satisfy the given predicate.
    default boolean
    removeIf(Predicate<? super Character> filter)
    Deprecated.
    Please use the corresponding type-specific method instead.
    boolean
    retainAll(CharCollection c)
    Retains in this collection only elements from the given type-specific collection.
    default CharSpliterator
    spliterator()
    Returns a type-specific spliterator on the elements of this collection.
    default Stream<Character>
    stream()
    Deprecated.
    Please use the corresponding type-specific method instead.
    char[]
    toArray(char[] 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.
    char[]
    toCharArray()
    Returns a primitive type array containing the items of this collection.
    default char[]
    toCharArray(char[] a)
    Deprecated.
    Please use toArray() instead—this method is redundant and will be removed in the future.

    Methods inherited from interface it.unimi.dsi.fastutil.chars.CharIterable

    forEach, forEach, forEach

    Methods inherited from interface java.util.Collection

    addAll, clear, containsAll, equals, hashCode, isEmpty, removeAll, retainAll, size, toArray, toArray, toArray

  • Method Details

    • iterator

      CharIterator iterator()
      Returns a type-specific iterator on the elements of this collection.
      Specified by:
      iterator in interface CharIterable
      Specified by:
      iterator in interface Collection<Character>
      Specified by:
      iterator in interface Iterable<Character>
      Returns:
      a type-specific iterator on the elements of this collection.
      See Also:
      API Notes:
      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.

    • intIterator

      default IntIterator intIterator()
      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 CharIterable
      Returns:
      a widened primitive iterator on the elements of this collection.
      Since:
      8.5.0

    • spliterator

      default CharSpliterator spliterator()
      Returns a type-specific spliterator on the elements of this collection.

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

      Specified by:
      spliterator in interface CharIterable
      Specified by:
      spliterator in interface Collection<Character>
      Specified by:
      spliterator in interface Iterable<Character>
      Returns:
      a type-specific spliterator on the elements of this collection.
      Since:
      8.5.0
      API Notes:
      This specification strengthens the one given in Collection.spliterator().

      Also, this is generally the only spliterator method subclasses should override.

      Implementation Specification:
      The default implementation returns a late-binding spliterator (see Spliterator for documentation on what binding policies mean) that wraps this instance's type specific iterator().

      Additionally, it reports Spliterator.SIZED

      Implementation Notes:
      As this default implementation wraps the iterator, and Iterator is an inherently linear API, the returned spliterator will yield limited performance gains when run in parallel contexts, as the returned spliterator's trySplit() will have linear runtime.

    • intSpliterator

      default IntSpliterator intSpliterator()
      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 CharIterable
      Returns:
      a widened primitive spliterator on the elements of this collection.
      Since:
      8.5.0

    • add

      boolean add(char key)
      Ensures that this collection contains the specified element (optional operation).
      See Also:

    • contains

      boolean contains(char key)
      Returns true if this collection contains the specified element.
      See Also:

    • rem

      boolean rem(char key)
      Removes a single instance of the specified element from this collection, if it is present (optional operation).

      Note that this method should be called remove(), but the clash with the similarly named index-based method in the List interface forces us to use a distinguished name. For simplicity, the set interfaces reinstates remove().

      See Also:

    • add

      @Deprecated default boolean add(Character key)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      add in interface Collection<Character>

    • contains

      @Deprecated default boolean contains(Object key)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      contains in interface Collection<Character>

    • remove

      @Deprecated default boolean remove(Object key)
      Deprecated.
      Please use (and implement) the rem() method instead.
      Specified by:
      remove in interface Collection<Character>

    • toCharArray

      char[] toCharArray()
      Returns a primitive type array containing the items of this collection.
      Returns:
      a primitive type array containing the items of this collection.
      See Also:

    • toCharArray

      @Deprecated default char[] toCharArray(char[] a)
      Deprecated.
      Please use toArray() instead—this method is redundant and will be removed in the future.
      Returns a primitive type array containing the items of this collection.

      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.

      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:

    • toArray

      char[] toArray(char[] 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.

      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.

      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:

    • addAll

      boolean addAll(CharCollection c)
      Adds all elements of the given type-specific collection to this collection.
      Parameters:
      c - a type-specific collection.
      Returns:
      true if this collection changed as a result of the call.
      See Also:

    • containsAll

      boolean containsAll(CharCollection c)
      Checks whether this collection contains all elements from the given type-specific collection.
      Parameters:
      c - a type-specific collection.
      Returns:
      true if this collection contains all elements of the argument.
      See Also:

    • removeAll

      boolean removeAll(CharCollection c)
      Remove from this collection all elements in the given type-specific collection.
      Parameters:
      c - a type-specific collection.
      Returns:
      true if this collection changed as a result of the call.
      See Also:

    • removeIf

      @Deprecated default boolean removeIf(Predicate<? super Character> filter)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      removeIf in interface Collection<Character>

    • removeIf

      default boolean removeIf(CharPredicate filter)
      Remove from this collection all elements which satisfy the given predicate.
      Parameters:
      filter - a predicate which returns true for elements to be removed.
      Returns:
      true if any elements were removed.
      See Also:
      API Notes:
      Implementing classes should generally override this method, and take the default implementation of the other overloads which will delegate to this method (after proper conversions).

    • removeIf

      default boolean removeIf(IntPredicate filter)
      Remove from this collection all elements which satisfy the given predicate.
      Parameters:
      filter - a predicate which returns true for elements to be removed.
      Returns:
      true if any elements were removed.
      See Also:
      Implementation Notes:
      Unless the argument is type-specific, this method will introduce an intermediary lambda to perform widening casts. Please use the type-specific overload to avoid this overhead.

    • retainAll

      boolean retainAll(CharCollection c)
      Retains in this collection only elements from the given type-specific collection.
      Parameters:
      c - a type-specific collection.
      Returns:
      true if this collection changed as a result of the call.
      See Also:

    • stream

      @Deprecated default Stream<Character> stream()
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      stream in interface Collection<Character>

    • intStream

      default IntStream intStream()
      Return a primitive stream over the elements, performing widening casts if needed.

      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.

      Returns:
      a primitive stream over the elements.
      See Also:

    • parallelStream

      @Deprecated default Stream<Character> parallelStream()
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      parallelStream in interface Collection<Character>

    • intParallelStream

      default IntStream intParallelStream()
      Return a parallel primitive stream over the elements, performing widening casts if needed.

      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.

      Returns:
      a parallel primitive stream over the elements.
      See Also: