com.github.dm.jrt.function.FunctionalRoutineBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jroutine Show documentation

Parallel programming on the go

There is a newer version: 5.9.0

/*
 * 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.github.dm.jrt.function;

import com.github.dm.jrt.builder.ConfigurableBuilder;
import com.github.dm.jrt.channel.ResultChannel;
import com.github.dm.jrt.invocation.CommandInvocation;

import org.jetbrains.annotations.NotNull;

/**
 * Interface defining a builder of functional routines.
 * 
 * Created by davide-maestroni on 10/18/2015.
 */
public interface FunctionalRoutineBuilder extends ConfigurableBuilder {

    /**
     * Builds and returns a new functional routine generating outputs from the specified command
     * invocation.
     *
     * @param invocation the command invocation instance.
     * @param       the output data type.
     * @return the newly created routine instance.
     */
    @NotNull
     FunctionalRoutine buildFrom(@NotNull CommandInvocation invocation);

    /**
     * Builds and returns a new functional routine generating outputs from the specified consumer.
     *
     * @param consumer the consumer instance.
     * @param     the output data type.
     * @return the newly created routine instance.
     */
    @NotNull
     FunctionalRoutine buildFrom(
            @NotNull Consumer> consumer);

    /**
     * Builds and returns a new functional routine generating outputs from the specified supplier.
     *
     * @param supplier the supplier instance.
     * @param     the output data type.
     * @return the newly created routine instance.
     */
    @NotNull
     FunctionalRoutine buildFrom(@NotNull Supplier supplier);

    /**
     * Builds and returns a functional routine.
     *
     * @param  the data type.
     * @return the newly created routine instance.
     */
    @NotNull
     FunctionalRoutine buildRoutine();
}