ByteIterable (byte-common 8.5.13-SNAPSHOT API)

All Superinterfaces:

java.lang.Iterable<java.lang.Byte>

All Known Subinterfaces:

ByteBidirectionalIterable, ByteCollection, ByteList

All Known Implementing Classes:

AbstractByteCollection, AbstractByteList, AbstractByteList.ByteRandomAccessSubList, AbstractByteList.ByteSubList, ByteArrayList, ByteCollections.EmptyCollection, ByteCollections.IterableCollection, ByteImmutableList, ByteLists.EmptyList, ByteLists.Singleton, ByteLists.SynchronizedList, ByteLists.SynchronizedRandomAccessList, ByteLists.UnmodifiableList, ByteLists.UnmodifiableRandomAccessList
```
public interface ByteIterable
extends java.lang.Iterable<java.lang.Byte>
```
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:

Iterable

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default void`	`forEach(it.unimi.dsi.fastutil.bytes.ByteConsumer 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(java.util.function.Consumer<? super java.lang.Byte> action)` Deprecated. Please use the corresponding type-specific method instead.
`default void`	`forEach(java.util.function.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.
`default it.unimi.dsi.fastutil.ints.IntIterator`	`intIterator()` Returns a widened primitive iterator on the elements of this iterable.
`default it.unimi.dsi.fastutil.ints.IntSpliterator`	`intSpliterator()` Returns widened primitive spliterator on the elements of this iterable.
`it.unimi.dsi.fastutil.bytes.ByteIterator`	`iterator()` Returns a type-specific iterator.
`default it.unimi.dsi.fastutil.bytes.ByteSpliterator`	`spliterator()` Returns a type-specific spliterator on the elements of this iterable.

- Method Detail
  - iterator
```
it.unimi.dsi.fastutil.bytes.ByteIterator iterator()
```
    Returns a type-specific iterator.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<java.lang.Byte>
    
    Returns:
    
    a type-specific iterator.
    
    See Also:
    
    Iterable.iterator()
  - 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.
    
    Returns:
    
    a widened primitive iterator on the elements of this iterable.
    
    Since:
    
    8.5.0
  - spliterator
```
default it.unimi.dsi.fastutil.bytes.ByteSpliterator spliterator()
```
    Returns a type-specific spliterator on the elements of this iterable.
    
    Specified by:
    
    spliterator in interface java.lang.Iterable<java.lang.Byte>
    
    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.
    
    Returns:
    
    a widened primitive spliterator on the elements of this iterable.
    
    Since:
    
    8.5.0
  - forEach
```
default void forEach(it.unimi.dsi.fastutil.bytes.ByteConsumer 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:
    
    Iterable.forEach(java.util.function.Consumer)
  - forEach
```
default void forEach(java.util.function.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:
    
    Iterable.forEach(java.util.function.Consumer)
  - forEach
```
@Deprecated
default void forEach(java.util.function.Consumer<? super java.lang.Byte> action)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    forEach in interface java.lang.Iterable<java.lang.Byte>

Interface ByteIterable

Method Summary

Method Detail

iterator

intIterator

spliterator

intSpliterator

forEach

forEach

forEach