net.yetamine.lang.collections.Iterators Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of net.yetamine.lang Show documentation

Small extensions for the core Java language libraries.

The newest version!

/*
 * Copyright 2016 Yetamine
 *
 * 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 net.yetamine.lang.collections;

import java.util.Iterator;
import java.util.Spliterators;
import java.util.stream.Stream;
import java.util.stream.StreamSupport;

/**
 * Tools for dealing with iterators.
 */
public final class Iterators {

    /**
     * Prevents creating instances of this class.
     */
    private Iterators() {
        throw new AssertionError();
    }

    /**
     * Makes a {@link Stream} from the given iterator.
     *
     * 
     * The stream has an unknown size, it is sequential and not ordered.
     *
     * @param 
     *            the type of the elements
     * @param iterator
     *            the iterator to use. It must not be {@code null}.
     *
     * @return the stream
     */
    public static  Stream stream(Iterator iterator) {
        return StreamSupport.stream(Spliterators.spliteratorUnknownSize(iterator, 0), false);
    }
}