com.github.dm.jrt.channel.InvocationChannel 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.channel;

import com.github.dm.jrt.util.TimeDuration;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.concurrent.TimeUnit;

/**
 * Interface defining an invocation input channel, that is the channel used to pass input data to
 * the routine invocation.
 * 
 * Created by davide-maestroni on 09/15/2014.
 *
 * @param   the input data type.
 * @param  the output data type.
 */
public interface InvocationChannel extends InputChannel {

    /**
     * {@inheritDoc}
     */
    @NotNull
    InvocationChannel after(@NotNull TimeDuration delay);

    /**
     * {@inheritDoc}
     */
    @NotNull
    InvocationChannel after(long delay, @NotNull TimeUnit timeUnit);

    /**
     * {@inheritDoc}
     */
    @NotNull
    InvocationChannel now();

    /**
     * {@inheritDoc}
     */
    @NotNull
    InvocationChannel orderByCall();

    /**
     * {@inheritDoc}
     */
    @NotNull
    InvocationChannel orderByChance();

    /**
     * {@inheritDoc}
     */
    @NotNull
    InvocationChannel orderByDelay();

    /**
     * {@inheritDoc}
     */
    @NotNull
    InvocationChannel pass(@Nullable OutputChannel channel);

    /**
     * {@inheritDoc}
     */
    @NotNull
    InvocationChannel pass(@Nullable Iterable inputs);

    /**
     * {@inheritDoc}
     */
    @NotNull
    InvocationChannel pass(@Nullable IN input);

    /**
     * {@inheritDoc}
     */
    @NotNull
    InvocationChannel pass(@Nullable IN... inputs);

    /**
     * Closes the input channel and returns the output one.
     *
     * @return the routine output channel.
     * @throws java.lang.IllegalStateException if this method has been already called.
     */
    @NotNull
    OutputChannel result();
}