Package io.vavr

Interface Iterable<T>

Type Parameters:

T - the element type

All Superinterfaces:

java.lang.Iterable<T>

All Known Subinterfaces:

Future<T>, IndexedSeq<T>, Iterator<T>, LinearSeq<T>, Map<K,V>, Multimap<K,V>, Seq<T>, Set<T>, SortedMap<K,V>, SortedMultimap<K,V>, SortedSet<T>, Traversable<T>

All Known Implementing Classes:

Array, BitSet, CharSeq, Either, Either.Left, Either.Right, HashMap, HashMultimap, HashSet, LinkedHashMap, LinkedHashMultimap, LinkedHashSet, List, List.Cons, List.Nil, Option, Option.None, Option.Some, PriorityQueue, Queue, Stream, Stream.Cons, Stream.Empty, Tree, Tree.Empty, Tree.Node, TreeMap, TreeMultimap, TreeSet, Try, Try.Failure, Try.Success, Validation, Validation.Invalid, Validation.Valid, Vector

public interface Iterable<T>
extends java.lang.Iterable<T>

Extension of the well-known Java Iterable in the sense that a rich Vavr Iterator is returned by iterator().

Method Summary

Modifier and Type	Method	Description
Iterator<T>	iterator()	Returns a rich Iterator that allows us to perform intermediate, sequential operations known from Vavr's collection library.
default <C> C	to(java.util.function.Function<? super java.lang.Iterable<T>,C> fromIterable)	A generic conversion function.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

iterator

Iterator<T> iterator()

Returns a rich Iterator that allows us to perform intermediate, sequential operations known from Vavr's collection library.

Specified by:

iterator in interface java.lang.Iterable<T>

Returns:

an Iterator instance (that might be a singleton in the empty case)

to

default <C> C to(java.util.function.Function<? super java.lang.Iterable<T>,C> fromIterable)

A generic conversion function.

Example:

 List<Integer> list = Option.some(1).to(List::ofAll);
 

Type Parameters:

C - the target type of the conversion

Parameters:

fromIterable - A function that converts a Iterable to some type C.

Returns:

a new instance of type C that must not be null per contract