org.d2ab.iterator.PredicatePartitioningIterator Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2016 Daniel Skogquist Åborg
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.d2ab.iterator;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.NoSuchElementException;
import java.util.function.BiPredicate;

/**
 * An {@link Iterator} that can batch up another iterator by comparing two items in sequence and deciding whether
 * to split up in a batch on those items.
 */
public abstract class PredicatePartitioningIterator extends DelegatingMappingIterator {
	private final BiPredicate predicate;
	private T next;
	private boolean hasNext;

	public PredicatePartitioningIterator(Iterator iterator, BiPredicate predicate) {
		super(iterator);
		this.predicate = predicate;
	}

	@Override
	public boolean hasNext() {
		if (!hasNext && super.hasNext()) {
			next = iterator.next();
			hasNext = true;
		}
		return hasNext;
	}

	@Override
	public S next() {
		if (!hasNext())
			throw new NoSuchElementException();

		List buffer = new ArrayList<>();
		do {
			buffer.add(next);
			hasNext = iterator.hasNext();
			if (!hasNext)
				break;
			T following = iterator.next();
			boolean split = predicate.test(next, following);
			next = following;
			if (split)
				break;
		} while (hasNext);

		return toSequence(buffer);
	}

	protected abstract S toSequence(List list);

	@Override
	public void remove() {
		throw new UnsupportedOperationException();
	}
}