org.incava.ijdk.collect

Class Iterate

java.lang.Object

org.incava.ijdk.collect.Iterate

public class Iterate
extends java.lang.Object

Creates various types of Iterators, all of which are null safe (they can accept a null input).

Constructor Summary

Constructors

Constructor and Description
Iterate()

Method Summary

Modifier and Type	Method and Description
static java.lang.Iterable<java.lang.Integer>	count(int num) Returns an iterator to be executed num times.
static <T> ItIterable<T>	each(java.lang.Iterable<T> elements) An iterator that has a value (it.value()) and an index (it.index()).
static <T> ItIterable<T>	each(T[] ary) An iterator that has a value (it.value()) and an index (it.index()).
static <T> java.lang.Iterable<T>	over(java.lang.Iterable<T> elements) Returns an Iterable (iterator) for the collection, which can be null.
static <T> java.lang.Iterable<T>	over(T[] ary) Returns an Iterable (iterator) for the C-style array, which can be null.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Iterate

public Iterate()

Method Detail

count

public static java.lang.Iterable<java.lang.Integer> count(int num)

Returns an iterator to be executed num times.

Parameters:

num - the number of times to iterate

Returns:

an iterator

over

public static <T> java.lang.Iterable<T> over(T[] ary)

Returns an Iterable (iterator) for the C-style array, which can be null. If ary is null, an "empty" iterator will be returned.

Type Parameters:

T - the type of elements

Parameters:

ary - the array to iterate over; can be null

Returns:

an iterator for the array

See Also:

each(T[])

over

public static <T> java.lang.Iterable<T> over(java.lang.Iterable<T> elements)

Returns an Iterable (iterator) for the collection, which can be null. If coll is null, an "empty" iterator will be returned.

Type Parameters:

T - the type of elements

Parameters:

elements - the elements to iterate over; can be null

Returns:

an iterator for the collection

See Also:

each(T[])

each

public static <T> ItIterable<T> each(T[] ary)

An iterator that has a value (it.value()) and an index (it.index()).

     for (It<String> it : Iterate.each(array)) {
         System.out.println("element #" + it.index() + ": " + it.value());
     }
 

Type Parameters:

T - the type of elements

Parameters:

ary - the array to iterate over; can be null

Returns:

an iterator for the array

See Also:

over(T[]), It

each

public static <T> ItIterable<T> each(java.lang.Iterable<T> elements)

An iterator that has a value (it.value()) and an index (it.index()).

     for (It<String> it : Iterate.each(list)) {
         System.out.println("element #" + it.index() + ": " + it.value());
     }
 

Type Parameters:

T - the type of elements

Parameters:

elements - the elements to iterate over; can be null

Returns:

an iterator for the elements

See Also:

over(T[]), It