org.d2ab.iterator.SwappingIterator 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.Iterator;
import java.util.function.BiPredicate;

/**
 * An {@link Iterator} that swaps any pair of items in the iteration that match the given predicate.
 */
public class SwappingIterator extends ForwardPeekingMappingIterator {
	private final BiPredicate swapPredicate;

	public SwappingIterator(Iterator iterator, BiPredicate swapPredicate) {
		super(iterator, null);
		this.swapPredicate = swapPredicate;
	}

	@Override
	protected T mapFollowing(boolean hasFollowing, T following) {
		if (!hasFollowing || !swapPredicate.test(next, following)) {
			return following;
		}

		T swap = next;
		next = following;
		return swap;
	}

	@Override
	protected T mapNext(T next, T following) {
		return next;
	}
}