com.speedment.runtime.core.stream.AutoClosingStream Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of tool-deploy Show documentation

A Speedment bundle that shades all dependencies into one jar. This is useful when deploying an application on a server.

The newest version!

/*
 *
 * Copyright (c) 2006-2019, Speedment, Inc. All Rights Reserved.
 *
 * 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 com.speedment.runtime.core.stream;

import com.speedment.runtime.core.internal.stream.autoclose.AutoClosingReferenceStream;

import java.util.stream.Stream;

public interface AutoClosingStream extends Stream {

    /**
     * Creates an returns a new Stream that automatically will invoke its {@link Stream#close()} method
     * whenever a terminating operation is invoked and where the stream elements are obtained from the given
     * {@code stream}.
     *
     * @param  Stream type
     * @param stream to wrap
     *
     * @return a new Stream that automatically will invoke its {@link Stream#close()} method
     * whenever a terminating operation is invoked and where the stream elements are obtained from the given
     * {@code stream}
     *
     * @throws NullPointerException if the provided {@code stream} is {@code null}
     */
    static  Stream of(Stream stream) {
        return new AutoClosingReferenceStream<>(stream);
    }

    /**
     * Creates an returns a new Stream that automatically will invoke its {@link Stream#close()} method
     * whenever a terminating operation is invoked and where the stream elements are obtained from the given
     * {@code stream}.
     *
     * @param  Stream type
     * @param stream to wrap
     * @param allowStreamIteratorAndSpliterator if the methods {@link Stream#iterator()} and
     * {@link Stream#spliterator()} are allowed.
     *
     * @return a new Stream that automatically will invoke its {@link Stream#close()} method
     * whenever a terminating operation is invoked and where the stream elements are obtained from the given
     * {@code stream}
     *
     * @throws NullPointerException if the provided {@code stream} is {@code null}
     */
    static  Stream of(
        final Stream stream,
        final boolean allowStreamIteratorAndSpliterator
    ) {
        return new AutoClosingReferenceStream<>(stream, allowStreamIteratorAndSpliterator);
    }

}