Iterable (Java SE 9 & JDK 9 ) (original) (raw)
- Type Parameters:
T- the type of elements returned by the iterator
All Known Subinterfaces:[BeanContext](../../java/beans/beancontext/BeanContext.html "interface in java.beans.beancontext"),[BeanContextServices](../../java/beans/beancontext/BeanContextServices.html "interface in java.beans.beancontext"),[BlockingDeque](../../java/util/concurrent/BlockingDeque.html "interface in java.util.concurrent")<E>,[BlockingQueue](../../java/util/concurrent/BlockingQueue.html "interface in java.util.concurrent")<E>,[Collection](../../java/util/Collection.html "interface in java.util")<E>,[Deque](../../java/util/Deque.html "interface in java.util")<E>,[DirectoryStream](../../java/nio/file/DirectoryStream.html "interface in java.nio.file")<T>,[EventSet](../../com/sun/jdi/event/EventSet.html "interface in com.sun.jdi.event"),[List](../../java/util/List.html "interface in java.util")<E>,[NavigableSet](../../java/util/NavigableSet.html "interface in java.util")<E>,[NodeSetData](../../javax/xml/crypto/NodeSetData.html "interface in javax.xml.crypto")<T>,[ObservableList](../../javafx/collections/ObservableList.html "interface in javafx.collections")<E>,[ObservableListValue](../../javafx/beans/value/ObservableListValue.html "interface in javafx.beans.value")<E>,[ObservableSet](../../javafx/collections/ObservableSet.html "interface in javafx.collections")<E>,[ObservableSetValue](../../javafx/beans/value/ObservableSetValue.html "interface in javafx.beans.value")<E>,[Path](../../java/nio/file/Path.html "interface in java.nio.file"),[Queue](../../java/util/Queue.html "interface in java.util")<E>,[SecureDirectoryStream](../../java/nio/file/SecureDirectoryStream.html "interface in java.nio.file")<T>,[Set](../../java/util/Set.html "interface in java.util")<E>,[SortedSet](../../java/util/SortedSet.html "interface in java.util")<E>,[TransferQueue](../../java/util/concurrent/TransferQueue.html "interface in java.util.concurrent")<E>,[WritableListValue](../../javafx/beans/value/WritableListValue.html "interface in javafx.beans.value")<E>,[WritableSetValue](../../javafx/beans/value/WritableSetValue.html "interface in javafx.beans.value")<E>,[XPathNodes](../../javax/xml/xpath/XPathNodes.html "interface in javax.xml.xpath")
All Known Implementing Classes:[AbstractCollection](../../java/util/AbstractCollection.html "class in java.util"),[AbstractList](../../java/util/AbstractList.html "class in java.util"),[AbstractQueue](../../java/util/AbstractQueue.html "class in java.util"),[AbstractSequentialList](../../java/util/AbstractSequentialList.html "class in java.util"),[AbstractSet](../../java/util/AbstractSet.html "class in java.util"),[ArrayBlockingQueue](../../java/util/concurrent/ArrayBlockingQueue.html "class in java.util.concurrent"),[ArrayDeque](../../java/util/ArrayDeque.html "class in java.util"),[ArrayList](../../java/util/ArrayList.html "class in java.util"),[AttributeList](../../javax/management/AttributeList.html "class in javax.management"),[BatchUpdateException](../../java/sql/BatchUpdateException.html "class in java.sql"),[BeanContextServicesSupport](../../java/beans/beancontext/BeanContextServicesSupport.html "class in java.beans.beancontext"),[BeanContextSupport](../../java/beans/beancontext/BeanContextSupport.html "class in java.beans.beancontext"),[ConcurrentHashMap.KeySetView](../../java/util/concurrent/ConcurrentHashMap.KeySetView.html "class in java.util.concurrent"),[ConcurrentLinkedDeque](../../java/util/concurrent/ConcurrentLinkedDeque.html "class in java.util.concurrent"),[ConcurrentLinkedQueue](../../java/util/concurrent/ConcurrentLinkedQueue.html "class in java.util.concurrent"),[ConcurrentSkipListSet](../../java/util/concurrent/ConcurrentSkipListSet.html "class in java.util.concurrent"),[CopyOnWriteArrayList](../../java/util/concurrent/CopyOnWriteArrayList.html "class in java.util.concurrent"),[CopyOnWriteArraySet](../../java/util/concurrent/CopyOnWriteArraySet.html "class in java.util.concurrent"),[DataTruncation](../../java/sql/DataTruncation.html "class in java.sql"),[DelayQueue](../../java/util/concurrent/DelayQueue.html "class in java.util.concurrent"),[DocTreePath](../../com/sun/source/util/DocTreePath.html "class in com.sun.source.util"),[EnumSet](../../java/util/EnumSet.html "class in java.util"),[FilteredList](../../javafx/collections/transformation/FilteredList.html "class in javafx.collections.transformation"),[HashSet](../../java/util/HashSet.html "class in java.util"),[JobStateReasons](../../javax/print/attribute/standard/JobStateReasons.html "class in javax.print.attribute.standard"),[LinkedBlockingDeque](../../java/util/concurrent/LinkedBlockingDeque.html "class in java.util.concurrent"),[LinkedBlockingQueue](../../java/util/concurrent/LinkedBlockingQueue.html "class in java.util.concurrent"),[LinkedHashSet](../../java/util/LinkedHashSet.html "class in java.util"),[LinkedList](../../java/util/LinkedList.html "class in java.util"),[LinkedTransferQueue](../../java/util/concurrent/LinkedTransferQueue.html "class in java.util.concurrent"),[ListBinding](../../javafx/beans/binding/ListBinding.html "class in javafx.beans.binding"),[ListExpression](../../javafx/beans/binding/ListExpression.html "class in javafx.beans.binding"),[ListProperty](../../javafx/beans/property/ListProperty.html "class in javafx.beans.property"),[ListPropertyBase](../../javafx/beans/property/ListPropertyBase.html "class in javafx.beans.property"),[ModifiableObservableListBase](../../javafx/collections/ModifiableObservableListBase.html "class in javafx.collections"),[ObservableListBase](../../javafx/collections/ObservableListBase.html "class in javafx.collections"),[PriorityBlockingQueue](../../java/util/concurrent/PriorityBlockingQueue.html "class in java.util.concurrent"),[PriorityQueue](../../java/util/PriorityQueue.html "class in java.util"),[ReadOnlyListProperty](../../javafx/beans/property/ReadOnlyListProperty.html "class in javafx.beans.property"),[ReadOnlyListPropertyBase](../../javafx/beans/property/ReadOnlyListPropertyBase.html "class in javafx.beans.property"),[ReadOnlyListWrapper](../../javafx/beans/property/ReadOnlyListWrapper.html "class in javafx.beans.property"),[ReadOnlySetProperty](../../javafx/beans/property/ReadOnlySetProperty.html "class in javafx.beans.property"),[ReadOnlySetPropertyBase](../../javafx/beans/property/ReadOnlySetPropertyBase.html "class in javafx.beans.property"),[ReadOnlySetWrapper](../../javafx/beans/property/ReadOnlySetWrapper.html "class in javafx.beans.property"),[RoleList](../../javax/management/relation/RoleList.html "class in javax.management.relation"),[RoleUnresolvedList](../../javax/management/relation/RoleUnresolvedList.html "class in javax.management.relation"),[RowSetWarning](../../javax/sql/rowset/RowSetWarning.html "class in javax.sql.rowset"),[SerialException](../../javax/sql/rowset/serial/SerialException.html "class in javax.sql.rowset.serial"),[ServiceLoader](../../java/util/ServiceLoader.html "class in java.util"),[SetBinding](../../javafx/beans/binding/SetBinding.html "class in javafx.beans.binding"),[SetExpression](../../javafx/beans/binding/SetExpression.html "class in javafx.beans.binding"),[SetProperty](../../javafx/beans/property/SetProperty.html "class in javafx.beans.property"),[SetPropertyBase](../../javafx/beans/property/SetPropertyBase.html "class in javafx.beans.property"),[SimpleListProperty](../../javafx/beans/property/SimpleListProperty.html "class in javafx.beans.property"),[SimpleSetProperty](../../javafx/beans/property/SimpleSetProperty.html "class in javafx.beans.property"),[SortedList](../../javafx/collections/transformation/SortedList.html "class in javafx.collections.transformation"),[SQLClientInfoException](../../java/sql/SQLClientInfoException.html "class in java.sql"),[SQLDataException](../../java/sql/SQLDataException.html "class in java.sql"),[SQLException](../../java/sql/SQLException.html "class in java.sql"),[SQLFeatureNotSupportedException](../../java/sql/SQLFeatureNotSupportedException.html "class in java.sql"),[SQLIntegrityConstraintViolationException](../../java/sql/SQLIntegrityConstraintViolationException.html "class in java.sql"),[SQLInvalidAuthorizationSpecException](../../java/sql/SQLInvalidAuthorizationSpecException.html "class in java.sql"),[SQLNonTransientConnectionException](../../java/sql/SQLNonTransientConnectionException.html "class in java.sql"),[SQLNonTransientException](../../java/sql/SQLNonTransientException.html "class in java.sql"),[SQLRecoverableException](../../java/sql/SQLRecoverableException.html "class in java.sql"),[SQLSyntaxErrorException](../../java/sql/SQLSyntaxErrorException.html "class in java.sql"),[SQLTimeoutException](../../java/sql/SQLTimeoutException.html "class in java.sql"),[SQLTransactionRollbackException](../../java/sql/SQLTransactionRollbackException.html "class in java.sql"),[SQLTransientConnectionException](../../java/sql/SQLTransientConnectionException.html "class in java.sql"),[SQLTransientException](../../java/sql/SQLTransientException.html "class in java.sql"),[SQLWarning](../../java/sql/SQLWarning.html "class in java.sql"),[Stack](../../java/util/Stack.html "class in java.util"),[SyncFactoryException](../../javax/sql/rowset/spi/SyncFactoryException.html "class in javax.sql.rowset.spi"),[SynchronousQueue](../../java/util/concurrent/SynchronousQueue.html "class in java.util.concurrent"),[SyncProviderException](../../javax/sql/rowset/spi/SyncProviderException.html "class in javax.sql.rowset.spi"),[TransformationList](../../javafx/collections/transformation/TransformationList.html "class in javafx.collections.transformation"),[TreePath](../../com/sun/source/util/TreePath.html "class in com.sun.source.util"),[TreeSet](../../java/util/TreeSet.html "class in java.util"),[Vector](../../java/util/Vector.html "class in java.util")
public interface Iterable
Implementing this interface allows an object to be the target of the enhancedfor statement (sometimes called the "for-each loop" statement).
Since:
1.5
See The Java™ Language Specification:
14.14.2 The enhanced for statement
Method Summary
All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type Method Description 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. Iterator<T> iterator() Returns an iterator over elements of type T. default Spliterator<T> spliterator() Creates a Spliterator over the elements described by thisIterable. Method Detail
* #### iterator [Iterator](../../java/util/Iterator.html "interface in java.util")<[T](../../java/lang/Iterable.html "type parameter in Iterable")> iterator() Returns an iterator over elements of type `T`. Returns: an Iterator. * #### forEach default void forEach([Consumer](../../java/util/function/Consumer.html "interface in java.util.function")<? super [T](../../java/lang/Iterable.html "type parameter in Iterable")> 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 Requirements: The default implementation behaves as if: ``` for (T t : this) action.accept(t); ``` Parameters: `action` \- The action to be performed for each element Throws: `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if the specified action is null Since: 1.8 * #### spliterator default [Spliterator](../../java/util/Spliterator.html "interface in java.util")<[T](../../java/lang/Iterable.html "type parameter in Iterable")> spliterator() Creates a [Spliterator](../../java/util/Spliterator.html "interface in java.util") over the elements described by this`Iterable`. Implementation Requirements: The default implementation creates an_[early-binding](../util/Spliterator.html#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: a `Spliterator` over the elements described by this`Iterable`. Since: 1.8
Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2017, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.