OpenJDK 1.23 · java.lang.Iterable · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public default void	forEach(Consumer<? super T> The action to be performed for each element action) Performs the given action for each element of the `Iterable` until all elements have been processed or the action throws an exception.
public Iterator<T>	Returns: an Iterator. iterator() Returns an iterator over elements of type `T`.
public default Spliterator<T>	Returns: a `Spliterator` over the elements described by this `Iterable`. spliterator() Creates a `Spliterator` over the elements described by this `Iterable`.

Method Detail

forEach back to summary

forEach	back to summary
public default void forEach(Consumer<? super T> action) Performs the given action for each element of the `Iterable` until all elements have been processed or the action throws an exception. Actions are performed in the order of iteration, if that order is specified. Exceptions thrown by the action are relayed to the caller. The behavior of this method is unspecified if the action performs side-effects that modify the underlying source of elements, unless an overriding class has specified a concurrent modification policy. Implementation Specification The default implementation behaves as if: `for (T t : this) action.accept(t);` Parameters action:Consumer<? super T> The action to be performed for each element Exceptions NullPointerException: if the specified action is null Since 1.8

public default void forEach(Consumer<? super T> action)

Performs the given action for each element of the Iterable until all elements have been processed or the action throws an exception. Actions are performed in the order of iteration, if that order is specified. Exceptions thrown by the action are relayed to the caller.

The behavior of this method is unspecified if the action performs side-effects that modify the underlying source of elements, unless an overriding class has specified a concurrent modification policy.

Implementation Specification

The default implementation behaves as if:

for (T t : this)
        action.accept(t);

Parameters

action:Consumer<? super T>: The action to be performed for each element

Exceptions

NullPointerException:: if the specified action is null

Since

1.8

iterator back to summary

iterator	back to summary
public Iterator<T> iterator() Returns an iterator over elements of type `T`. Returns:Iterator<T> an Iterator.

public Iterator<T> iterator()

Returns an iterator over elements of type T.

Returns:Iterator<T>: an Iterator.

spliterator back to summary

spliterator	back to summary
public default Spliterator<T> spliterator() Creates a `Spliterator` over the elements described by this `Iterable`. Implementation Specification The default implementation creates an early-binding spliterator from the iterable's `Iterator`. The spliterator inherits the fail-fast properties of the iterable's iterator. Implementation Note The default implementation should usually be overridden. The spliterator returned by the default implementation has poor splitting capabilities, is unsized, and does not report any spliterator characteristics. Implementing classes can nearly always provide a better implementation. Returns:Spliterator<T> a `Spliterator` over the elements described by this `Iterable`. Since 1.8

public default Spliterator<T> spliterator()

Creates a Spliterator over the elements described by this Iterable.

Implementation Specification

The default implementation creates an early-binding spliterator from the iterable's Iterator. The spliterator inherits the fail-fast properties of the iterable's iterator.

Implementation Note

The default implementation should usually be overridden. The spliterator returned by the default implementation has poor splitting capabilities, is unsized, and does not report any spliterator characteristics. Implementing classes can nearly always provide a better implementation.

Returns:Spliterator<T>: a Spliterator over the elements described by this Iterable.
Since: 1.8

public Interface Iterable<T>

Method Summary

Method Detail