net.markenwerk.commons.iterables

Class LongArrayIterable

java.lang.Object

net.markenwerk.commons.iterables.LongArrayIterable

All Implemented Interfaces:

Iterable<Long>

public final class LongArrayIterable
extends Object
implements Iterable<Long>

An LongArrayIterable is a Iterable that generates Iterators that iterate over a given long[].

Calling iterator() creates an instance of LongArrayIterator.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
LongArrayIterator	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

LongArrayIterable

public LongArrayIterable(long[] array)
                  throws IllegalArgumentException

Creates a new LongArrayIterable for the given long[].

Parameters:

array - The long[] to iterate over.

Throws:

IllegalArgumentException - If the given long[] is null.

LongArrayIterable

public LongArrayIterable(long[] array,
                         long replacement)
                  throws IllegalArgumentException

Creates a new LongArrayIterable for the given long[].

Parameters:

array - The long[] to iterate over.

replacement - The value to replace removed array with.

Throws:

IllegalArgumentException - If the given long[] is null.

Method Detail

iterator

public LongArrayIterator iterator()

Specified by:

iterator in interface Iterable<Long>