net.markenwerk.commons.iterables.LookAheadIterable Maven / Gradle / Ivy
/*
* Copyright (c) 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.LookAhead;
import net.markenwerk.commons.iterators.LookAheadIterator;
/**
* A {@link LookAheadIterable} is an {@link ProtectedIterable} that can be
* wrapped around a given {@link Iterator} and generates {@link Iterator
* Iterators} that yield a {@link LookAhead} container that holds the current
* and the next payload value of an {@link Iterator} that is generated by the
* given {@link Iterable}.
*
*
* Calling {@link LookAheadIterable#iterator()} creates an instance of
* {@link LookAheadIterator}.
*
* @param
* The payload type.
* @author Torsten Krause (tk at markenwerk dot net)
* @since 1.1.6
*/
public final class LookAheadIterable implements ProtectedIterable> {
private final Iterable iterable;
/**
* Creates a new {@link LookAheadIterable} from the given {@link Iterable}.
*
* @param iterable
* The {@link Iterable}, around which the new
* {@link LookAheadIterable} will be wrapped.
*
* @throws IllegalArgumentException
* If the given {@link Iterable} is {@literal null}.
*/
public LookAheadIterable(Iterable iterable) throws IllegalArgumentException {
if (null == iterable) {
throw new IllegalArgumentException("iterable is null");
}
this.iterable = iterable;
}
@Override
public LookAheadIterator iterator() {
return new LookAheadIterator(iterable.iterator());
}
}