net.markenwerk.commons.iterables

Class IntegerArrayIterable

java.lang.Object

net.markenwerk.commons.iterables.IntegerArrayIterable

All Implemented Interfaces:

Iterable<Integer>

public final class IntegerArrayIterable
extends Object
implements Iterable<Integer>

An IntegerArrayIterable is a Iterable that generates Iterators that iterate over a given int[].

Calling iterator() creates an instance of IntegerArrayIterator.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
IntegerArrayIterable(int[] array) Creates a new IntegerArrayIterable for the given int[].
IntegerArrayIterable(int[] array, int replacement) Creates a new IntegerArrayIterable for the given int[].

Method Summary

Modifier and Type	Method and Description
IntegerArrayIterator	iterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

IntegerArrayIterable

public IntegerArrayIterable(int[] array)
                     throws IllegalArgumentException

Creates a new IntegerArrayIterable for the given int[].

Parameters:

array - The int[] to iterate over.

Throws:

IllegalArgumentException - If the given int[] is null.

IntegerArrayIterable

public IntegerArrayIterable(int[] array,
                            int replacement)
                     throws IllegalArgumentException

Creates a new IntegerArrayIterable for the given int[].

Parameters:

array - The int[] to iterate over.

replacement - The value to replace removed array with.

Throws:

IllegalArgumentException - If the given int[] is null.

Method Detail

iterator

public IntegerArrayIterator iterator()

Specified by:

iterator in interface Iterable<Integer>