org.springframework.data.util.StreamUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-data-commons Show documentation
The newest version!
/*
 * Copyright 2015-2024 the original author or authors.
 *
 * 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
 *
 *      https://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.springframework.data.util;

import static java.util.stream.Collectors.*;

import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import java.util.Spliterator;
import java.util.Spliterators;
import java.util.Spliterators.AbstractSpliterator;
import java.util.function.BiFunction;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collector;
import java.util.stream.Stream;
import java.util.stream.StreamSupport;

import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.MultiValueMap;

/**
 * Spring Data specific Java {@link Stream} utility methods and classes.
 *
 * @author Thomas Darimont
 * @author Oliver Gierke
 * @since 1.10
 */
public interface StreamUtils {

	/**
	 * Returns a {@link Stream} backed by the given {@link Iterator}
	 *
	 * @param iterator must not be {@literal null}.
	 * @return
	 */
	static  Stream createStreamFromIterator(Iterator iterator) {

		Spliterator spliterator = Spliterators.spliteratorUnknownSize(iterator, Spliterator.NONNULL);
		return StreamSupport.stream(spliterator, false);
	}

	/**
	 * Returns a {@link Stream} backed by the given {@link CloseableIterator} and forwarding calls to
	 * {@link Stream#close()} to the iterator.
	 *
	 * @param iterator must not be {@literal null}.
	 * @return
	 * @since 2.0
	 */
	static  Stream createStreamFromIterator(CloseableIterator iterator) {

		Assert.notNull(iterator, "Iterator must not be null");

		return createStreamFromIterator((Iterator) iterator).onClose(() -> iterator.close());
	}

	/**
	 * Returns a {@link Collector} to create an unmodifiable {@link List}.
	 *
	 * @return will never be {@literal null}.
	 */
	static  Collector> toUnmodifiableList() {
		return collectingAndThen(toList(), Collections::unmodifiableList);
	}

	/**
	 * Returns a {@link Collector} to create an unmodifiable {@link Set}.
	 *
	 * @return will never be {@literal null}.
	 */
	static  Collector> toUnmodifiableSet() {
		return collectingAndThen(toSet(), Collections::unmodifiableSet);
	}

	/**
	 * Returns a {@link Collector} to create a {@link MultiValueMap}.
	 *
	 * @param keyFunction {@link Function} to create a key from an element of the {@link java.util.stream.Stream}
	 * @param valueFunction {@link Function} to create a value from an element of the {@link java.util.stream.Stream}
	 */
	static  Collector, MultiValueMap> toMultiMap(Function keyFunction,
			Function valueFunction) {
		return MultiValueMapCollector.of(keyFunction, valueFunction);
	}

	/**
	 * Creates a new {@link Stream} for the given value returning an empty {@link Stream} if the value is {@literal null}.
	 *
	 * @param source can be {@literal null}.
	 * @return a new {@link Stream} for the given value returning an empty {@link Stream} if the value is {@literal null}.
	 * @since 2.0.6
	 */
	static  Stream fromNullable(@Nullable T source) {
		return source == null ? Stream.empty() : Stream.of(source);
	}

	/**
	 * Zips the given {@link Stream}s using the given {@link BiFunction}. The resulting {@link Stream} will have the
	 * length of the shorter of the two, abbreviating the zipping when the shorter of the two {@link Stream}s is
	 * exhausted.
	 *
	 * @param left must not be {@literal null}.
	 * @param right must not be {@literal null}.
	 * @param combiner must not be {@literal null}.
	 * @return
	 * @since 2.1
	 */
	static  Stream zip(Stream left, Stream right, BiFunction combiner) {

		Assert.notNull(left, "Left stream must not be null");
		Assert.notNull(right, "Right must not be null");
		Assert.notNull(combiner, "Combiner must not be null");

		Spliterator lefts = left.spliterator();
		Spliterator rights = right.spliterator();

		long size = Long.min(lefts.estimateSize(), rights.estimateSize());
		int characteristics = lefts.characteristics() & rights.characteristics();
		boolean parallel = left.isParallel() || right.isParallel();

		return StreamSupport.stream(new AbstractSpliterator<>(size, characteristics) {

			@Override
			@SuppressWarnings("null")
			public boolean tryAdvance(Consumer action) {

				Sink leftSink = new Sink<>();
				Sink rightSink = new Sink<>();

				boolean leftAdvance = lefts.tryAdvance(leftSink);

				if (!leftAdvance) {
					return false;
				}

				boolean rightAdvance = rights.tryAdvance(rightSink);

				if (!rightAdvance) {
					return false;
				}

				action.accept(combiner.apply(leftSink.getValue(), rightSink.getValue()));

				return true;
			}
		}, parallel);
	}
}