Interface CharIterable

All Superinterfaces:
Iterable<Character>
All Known Subinterfaces:
CharBidirectionalIterable, CharCollection, CharList
All Known Implementing Classes:
AbstractCharCollection, AbstractCharList, AbstractCharList.CharRandomAccessSubList, AbstractCharList.CharSubList, CharArrayList, CharArrayList.SubList, CharCollections.EmptyCollection, CharCollections.IterableCollection, CharImmutableList, CharLists.EmptyList, CharLists.Singleton, CharLists.SynchronizedList, CharLists.SynchronizedRandomAccessList, CharLists.UnmodifiableList, CharLists.UnmodifiableRandomAccessList

public interface CharIterable extends Iterable<Character>
A type-specific Iterable that strengthens that specification of iterator() and forEach(Consumer).

Note that whenever there exist a primitive consumer in java.util.function (e.g., IntConsumer), trying to access any version of forEach(Consumer) using a lambda expression with untyped arguments will generate an ambiguous method error. This can be easily solved by specifying the type of the argument, as in

    intIterable.forEach((int x) -> { // Do something with x });
 

The same problem plagues, for example, PrimitiveIterator.OfInt.forEachRemaining(java.util.function.IntConsumer).

Warning: Java will let you write “colon” for statements with primitive-type loop variables; however, what is (unfortunately) really happening is that at each iteration an unboxing (and, in the case of fastutil type-specific data structures, a boxing) will be performed. Watch out.

See Also:
  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    forEach(it.unimi.dsi.fastutil.chars.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.
    default void
    forEach(Consumer<? super Character> action)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default void
    Performs the given action for each element of this type-specific Iterable, performing widening primitive casts, until all elements have been processed or the action throws an exception.
    default it.unimi.dsi.fastutil.ints.IntIterator
    Returns a widened primitive iterator on the elements of this iterable.
    default it.unimi.dsi.fastutil.ints.IntSpliterator
    Returns widened primitive spliterator on the elements of this iterable.
    it.unimi.dsi.fastutil.chars.CharIterator
    Returns a type-specific iterator.
    default it.unimi.dsi.fastutil.chars.CharSpliterator
    Returns a type-specific spliterator on the elements of this iterable.
  • Method Details

    • iterator

      it.unimi.dsi.fastutil.chars.CharIterator iterator()
      Returns a type-specific iterator.
      Specified by:
      iterator in interface Iterable<Character>
      Returns:
      a type-specific iterator.
      See Also:
    • intIterator

      default it.unimi.dsi.fastutil.ints.IntIterator intIterator()
      Returns a widened primitive iterator on the elements of this iterable.

      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.

      Returns:
      a widened primitive iterator on the elements of this iterable.
      Since:
      8.5.0
    • spliterator

      default it.unimi.dsi.fastutil.chars.CharSpliterator spliterator()
      Returns a type-specific spliterator on the elements of this iterable.
      Specified by:
      spliterator in interface Iterable<Character>
      Returns:
      a type-specific spliterator on the elements of this iterable.
      Since:
      8.5.0
    • intSpliterator

      default it.unimi.dsi.fastutil.ints.IntSpliterator intSpliterator()
      Returns widened primitive spliterator on the elements of this iterable.

      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.

      Returns:
      a widened primitive spliterator on the elements of this iterable.
      Since:
      8.5.0
    • forEach

      default void forEach(it.unimi.dsi.fastutil.chars.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.
      Parameters:
      action - the action to be performed for each element.
      Since:
      8.0.0
      See Also:
    • forEach

      default void forEach(IntConsumer action)
      Performs the given action for each element of this type-specific Iterable, performing widening primitive casts, until all elements have been processed or the action throws an exception.
      Parameters:
      action - the action to be performed for each element.
      Since:
      8.0.0
      See Also:
    • forEach

      @Deprecated default void forEach(Consumer<? super Character> action)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      forEach in interface Iterable<Character>