uk.gov.gchq.gaffer.commonutil.stream.MapStreamSupplier Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of common-util Show documentation

There is a newer version: 2.3.1

/*
 * Copyright 2017-2019 Crown Copyright
 *
 * 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 uk.gov.gchq.gaffer.commonutil.stream;

import uk.gov.gchq.gaffer.commonutil.CloseableUtil;

import java.io.IOException;
import java.util.function.Function;
import java.util.stream.Stream;

/**
 * A {@link uk.gov.gchq.gaffer.commonutil.stream.StreamSupplier} which uses a {@link java.util.function.Function}
 * to convert the input objects into output objects.
 *
 * @param  the type of input objects
 * @param  the type of output objects
 */
public class MapStreamSupplier implements StreamSupplier {
    private final Iterable input;
    private final Function function;

    /**
     * Default constructor.
     *
     * @param input    the input iterable
     * @param function the mapping function
     */
    public MapStreamSupplier(final Iterable input, final Function function) {
        this.input = input;
        this.function = function;
    }

    @Override
    public void close() throws IOException {
        CloseableUtil.close(input);
    }

    @Override
    public Stream get() {
        return Streams.toStream(input)
                .map(function);
    }
}