Package com.github.fracpete.javautils

Class Enumerate

java.lang.Object

com.github.fracpete.javautils.Enumerate

public class Enumerate
extends java.lang.Object

For generating a tuple of index and value for objects which classes implemented Iterable.

 import java.util.ArrayList;
 import java.util.List;
 import static com.github.fracpete.javautils.Enumerate.enumerate;

 List list = new ArrayList<>(Arrays.asList("a", "b", "c"));
 for (Enumerated e: enumerate(list))
   System.out.println(e.index + ": " + e.value);
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

EnumerateExamples

Constructor Summary

Constructors

Constructor	Description
Enumerate()

Method Summary

Modifier and Type	Method	Description
static <E> java.lang.Iterable<Enumerated<E>>	enumerate(E[] array)	Returns an Iterable wrapper around an array that combines index (starting at 0 with step 1) and value of the array item in the returned container object (Enumeration).
static <E> java.lang.Iterable<Enumerated<E>>	enumerate(E[] array, int start)	Returns an Iterable wrapper around an array that combines index (starting at "start" with step 1) and value of the array item in the returned container object (Enumeration).
static <E> java.lang.Iterable<Enumerated<E>>	enumerate(E[] array, int start, int step)	Returns an Iterable wrapper around an array that combines index (starting at "start" with step size "step") and value of the array item in the returned container object (Enumeration).
static <E> java.lang.Iterable<Enumerated<E>>	enumerate(java.lang.Iterable<E> iterable)	Returns an Iterable wrapper around an Iterable that combines index (starting at 0 with step 1) and value of the Iterable in the returned container object (Enumeration).
static <E> java.lang.Iterable<Enumerated<E>>	enumerate(java.lang.Iterable<E> iterable, int start)	Returns an Iterable wrapper around an Iterable that combines index (starting at "start" with step 1) and value of the Iterable in the returned container object (Enumeration).
static <E> java.lang.Iterable<Enumerated<E>>	enumerate(java.lang.Iterable<E> iterable, int start, int step)	Returns an Iterable wrapper around an Iterable that combines index (starting at "start" with step size "step") and value of the Iterable in the returned container object (Enumeration).
static <E> java.util.Iterator<Enumerated<E>>	enumerate(java.util.Iterator<E> iterable)	Returns an Iterable wrapper around an Iterator that combines index (starting at 0 with step 1) and value of the Iterable in the returned container object (Enumeration).
static <E> java.util.Iterator<Enumerated<E>>	enumerate(java.util.Iterator<E> iterable, int start)	Returns an Iterable wrapper around an Iterator that combines index (starting at "start" with step 1) and value of the Iterable in the returned container object (Enumeration).
static <E> java.util.Iterator<Enumerated<E>>	enumerate(java.util.Iterator<E> iterable, int start, int step)	Returns an Iterable wrapper around an Iterator that combines index (starting at "start" with step size "step") and value of the Iterable in the returned container object (Enumeration).

Methods inherited from class java.lang.Object

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

Constructor Detail

Enumerate

public Enumerate()

Method Detail

enumerate

public static <E> java.lang.Iterable<Enumerated<E>> enumerate(java.lang.Iterable<E> iterable)

Returns an Iterable wrapper around an Iterable that combines index (starting at 0 with step 1) and value of the Iterable in the returned container object (Enumeration).

Type Parameters:

E - the type of the iterable's objects

Parameters:

iterable - the iterable to wrap

Returns:

the iterable wrapper

enumerate

public static <E> java.lang.Iterable<Enumerated<E>> enumerate(java.lang.Iterable<E> iterable,
                                                              int start)

Returns an Iterable wrapper around an Iterable that combines index (starting at "start" with step 1) and value of the Iterable in the returned container object (Enumeration).

Type Parameters:

E - the type of the iterable's objects

Parameters:

iterable - the iterable to wrap

start - the starting index

Returns:

the iterable wrapper

enumerate

public static <E> java.lang.Iterable<Enumerated<E>> enumerate(java.lang.Iterable<E> iterable,
                                                              int start,
                                                              int step)

Returns an Iterable wrapper around an Iterable that combines index (starting at "start" with step size "step") and value of the Iterable in the returned container object (Enumeration).

Type Parameters:

E - the type of the iterable's objects

Parameters:

iterable - the iterable to wrap

start - the starting index

step - the step size

Returns:

the iterable wrapper

enumerate

public static <E> java.util.Iterator<Enumerated<E>> enumerate(java.util.Iterator<E> iterable)

Returns an Iterable wrapper around an Iterator that combines index (starting at 0 with step 1) and value of the Iterable in the returned container object (Enumeration).

Type Parameters:

E - the type of the Iterator's objects

Parameters:

iterable - the Iterator to wrap

Returns:

the Iterator wrapper

enumerate

public static <E> java.util.Iterator<Enumerated<E>> enumerate(java.util.Iterator<E> iterable,
                                                              int start)

Returns an Iterable wrapper around an Iterator that combines index (starting at "start" with step 1) and value of the Iterable in the returned container object (Enumeration).

Type Parameters:

E - the type of the Iterator's objects

Parameters:

iterable - the Iterator to wrap

start - the starting index

Returns:

the Iterator wrapper

enumerate

public static <E> java.util.Iterator<Enumerated<E>> enumerate(java.util.Iterator<E> iterable,
                                                              int start,
                                                              int step)

Returns an Iterable wrapper around an Iterator that combines index (starting at "start" with step size "step") and value of the Iterable in the returned container object (Enumeration).

Type Parameters:

E - the type of the Iterator's objects

Parameters:

iterable - the Iterator to wrap

start - the starting index

step - the step size

Returns:

the Iterator wrapper

enumerate

public static <E> java.lang.Iterable<Enumerated<E>> enumerate(E[] array)

Returns an Iterable wrapper around an array that combines index (starting at 0 with step 1) and value of the array item in the returned container object (Enumeration).

Type Parameters:

E - the type of the Iterator's objects

Parameters:

array - the array to wrap

Returns:

the Iterator wrapper

enumerate

public static <E> java.lang.Iterable<Enumerated<E>> enumerate(E[] array,
                                                              int start)

Returns an Iterable wrapper around an array that combines index (starting at "start" with step 1) and value of the array item in the returned container object (Enumeration).

Type Parameters:

E - the type of the Iterator's objects

Parameters:

array - the Iterator to wrap

start - the starting index

Returns:

the Iterator wrapper

enumerate

public static <E> java.lang.Iterable<Enumerated<E>> enumerate(E[] array,
                                                              int start,
                                                              int step)

Returns an Iterable wrapper around an array that combines index (starting at "start" with step size "step") and value of the array item in the returned container object (Enumeration).

Type Parameters:

E - the type of the Iterator's objects

Parameters:

array - the array to wrap

start - the starting index

step - the step size

Returns:

the Iterator wrapper