reactor.rx.stream.IterableStream Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2011-2014 Pivotal Software, Inc.
 *
 *  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 reactor.rx.stream;

import org.reactivestreams.Subscriber;
import reactor.core.reactivestreams.PublisherFactory;
import reactor.core.reactivestreams.SubscriberWithContext;
import reactor.fn.Consumer;
import reactor.fn.Function;
import reactor.rx.Stream;
import reactor.rx.Streams;

import java.util.Iterator;

/**
 * A Stream that emits {@link java.lang.Iterable} values one by one and then complete.
 * 
 * Since the stream retains the iterable in a final field, any {@link org.reactivestreams.Subscriber}
 * will replay all the iterable. This is a "Cold" stream.
 * 

 * Create such stream with the provided factory, E.g.:
 * 
 * {@code
 * Streams.just(1,2,3,4).consume(
 *    log::info,
 *    log::error,
 *    (-> log.info("complete"))
 * )
 * }
 * 
 *  * //Will log:
 * 1
 * 2
 * 3
 * 4
 * complete
 * 
 *
 * @author Stephane Maldini
 */
public final class IterableStream {

	/**
	 * Create an Iterable Stream Publisher
	 *
	 * @param defaultValues
	 * @param 
	 * @return
	 */
	public static  Stream create(final Iterable defaultValues) {
		return Streams.wrap(PublisherFactory.forEach(new Consumer>>() {
			@Override
			public void accept(SubscriberWithContext> subscriber) {
				final Iterator iterator = subscriber.context();
				if (iterator.hasNext()) {
					subscriber.onNext(iterator.next());
				} else {
					subscriber.onComplete();
					return;
				}

				if (!iterator.hasNext()) {
					subscriber.onComplete();
				}
			}
		}, new Function, Iterator>() {
			@Override
			public Iterator apply(Subscriber subscriber) {
				if (defaultValues == null) {
					subscriber.onComplete();
					throw PublisherFactory.PrematureCompleteException.INSTANCE;
				}
				return defaultValues.iterator();
			}
		}));
	}
}