net.markenwerk.commons.iterables.FloatArrayIterable Maven / Gradle / Ivy
/*
* Copyright (c) 2015, 2016 Torsten Krause, Markenwerk GmbH
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package net.markenwerk.commons.iterables;
import java.util.Iterator;
import net.markenwerk.commons.iterators.FloatArrayIterator;
/**
* An {@link FloatArrayIterable} is a {@link ProtectedIterable} that generates
* {@link Iterator Iterators} that iterate over a given {@code float[]}.
*
*
* Calling {@link FloatArrayIterable#iterator()} creates an instance of
* {@link FloatArrayIterator}.
*
* @author Torsten Krause (tk at markenwerk dot net)
* @since 1.0.0
*/
public final class FloatArrayIterable implements ProtectedIterable {
private final float[] array;
/**
* Creates a new {@link FloatArrayIterable} for the given {@code float[]}.
*
* @param array
* The {@code float[]} to iterate over.
*
* @throws IllegalArgumentException
* If the given {@code float[]} is {@literal null}.
*/
public FloatArrayIterable(float[] array) throws IllegalArgumentException {
if (null == array) {
throw new IllegalArgumentException("array is null");
}
this.array = array;
}
@Override
public FloatArrayIterator iterator() {
return new FloatArrayIterator(array);
}
}