Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.
added in API level 1

Iterable

public interface Iterable

java.lang.Iterable<T>


Implementing this interface allows an object to be the target of the "for-each loop" statement. See For-each Loop

Summary

Public methods

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.

abstract Iterator<T> iterator()

Returns an iterator over elements of type T.

default Spliterator<T> spliterator()

Creates a Spliterator over the elements described by this Iterable.

Public methods

forEach

added in API level 24
public 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. Unless otherwise specified by the implementing class, actions are performed in the order of iteration (if an iteration order is specified). Exceptions thrown by the action are relayed to the caller.

Implementation Requirements:
  • The default implementation behaves as if:

    for (T t : this)
             action.accept(t);
     
Parameters
action Consumer: The action to be performed for each element

Throws
NullPointerException if the specified action is null

iterator

added in API level 1
public abstract Iterator<T> iterator ()

Returns an iterator over elements of type T.

Returns
Iterator<T> an Iterator.

spliterator

added in API level 24
public Spliterator<T> spliterator ()

Creates a Spliterator over the elements described by this Iterable.

Implementation Requirements:
  • 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.