net.markenwerk.commons.iterables

Class DoubleArrayIterable

java.lang.Object

net.markenwerk.commons.iterables.DoubleArrayIterable

All Implemented Interfaces:

Iterable<Double>, BidirectionalIterable<Double>, ProtectedBidirectionalIterable<Double>

public final class DoubleArrayIterable
extends Object
implements ProtectedBidirectionalIterable<Double>

A DoubleArrayIterable is a ProtectedBidirectionalIterable that generates Iterators that iterate over a given double[].

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
DoubleArrayIterable(double... array) Creates a new DoubleArrayIterable.

Method Summary

Modifier and Type	Method and Description
DoubleArrayIterator	iterator() Returns a ProtectedIterator.

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

DoubleArrayIterable

public DoubleArrayIterable(double... array)
                    throws IllegalArgumentException

Creates a new DoubleArrayIterable.

Parameters:

array - The double[] to iterate over.

Throws:

IllegalArgumentException - If the given double[] is null.

Method Detail

iterator

public DoubleArrayIterator iterator()

Description copied from interface: ProtectedBidirectionalIterable

Returns a ProtectedIterator.

Specified by:

iterator in interface Iterable<Double>

Specified by:

iterator in interface BidirectionalIterable<Double>

Specified by:

iterator in interface ProtectedBidirectionalIterable<Double>

Returns:

A ProtectedIterator.