net.markenwerk.commons.iterables

Class FloatArrayIterable

java.lang.Object

net.markenwerk.commons.iterables.FloatArrayIterable

All Implemented Interfaces:

Iterable<Float>, BidirectionalIterable<Float>, ProtectedBidirectionalIterable<Float>

public final class FloatArrayIterable
extends Object
implements ProtectedBidirectionalIterable<Float>

A FloatArrayIterable is a ProtectedBidirectionalIterable that generates Iterators that iterate over a given float[].

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
FloatArrayIterable(float... array) Creates a new FloatArrayIterable.

Method Summary

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

FloatArrayIterable

public FloatArrayIterable(float... array)
                   throws IllegalArgumentException

Creates a new FloatArrayIterable.

Parameters:

array - The float[] to iterate over.

Throws:

IllegalArgumentException - If the given float[] is null.

Method Detail

iterator

public FloatArrayIterator iterator()

Description copied from interface: ProtectedBidirectionalIterable

Returns a ProtectedIterator.

Specified by:

iterator in interface Iterable<Float>

Specified by:

iterator in interface BidirectionalIterable<Float>

Specified by:

iterator in interface ProtectedBidirectionalIterable<Float>

Returns:

A ProtectedIterator.