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.CharSubList, AbstractCharCollection, AbstractCharList, AbstractCharList.CharSubList, AbstractCharSet, AbstractCharSortedSet, CharArrayList, CharArraySet, CharAVLTreeSet, CharBigArrayBigList, CharBigLists.EmptyBigList, CharBigLists.ListBigList, CharBigLists.Singleton, CharBigLists.SynchronizedBigList, CharBigLists.UnmodifiableBigList, CharCollections.EmptyCollection, CharCollections.IterableCollection, CharCollections.SynchronizedCollection, CharCollections.UnmodifiableCollection, CharLinkedOpenCustomHashSet, CharLinkedOpenHashSet, CharLists.EmptyList, CharLists.Singleton, CharLists.SynchronizedList, CharLists.SynchronizedRandomAccessList, CharLists.UnmodifiableList, CharLists.UnmodifiableRandomAccessList, 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().

See Also:
Collection

  • 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.
    CharIterator iterator()
    Returns a type-specific iterator on the elements of this collection.
    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​(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.
    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.
    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

    Methods inherited from interface java.util.Collection

    addAll, clear, containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, retainAll, size, spliterator, stream, toArray, toArray, toArray

  • Method Details

    • iterator

      CharIterator iterator()
      Returns a type-specific iterator on the elements of this collection.

      Note that this specification strengthens the one given in Iterable.iterator(), which was already strengthened in the corresponding type-specific class, but was weakened by the fact that this interface extends Collection.

      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:
      Iterable.iterator()

    • add

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

    • contains

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

    • 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:
      Collection.remove(Object)

    • 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:
      Collection.toArray()

    • toCharArray

      @Deprecated 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:
      Collection.toArray(Object[])

    • 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:
      Collection.toArray(Object[])

    • 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:
      Collection.addAll(Collection)

    • 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:
      Collection.containsAll(Collection)

    • 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:
      Collection.removeAll(Collection)

    • 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​(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:
      Collection.removeIf(java.util.function.Predicate)

    • 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:
      Collection.retainAll(Collection)