com.gh.bmd.jrt.channel.ParameterChannel 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.gh.bmd.jrt.channel;

import com.gh.bmd.jrt.time.TimeDuration;

import java.util.concurrent.TimeUnit;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * Interface defining a parameter input channel, that is the channel used to pass input data to the
 * routine invocation.
 * 
 * Created by davide on 9/15/14.
 *
 * @param   the input data type.
 * @param  the output data type.
 */
public interface ParameterChannel extends InputChannel {

    /**
     * {@inheritDoc}
     */
    @Nonnull
    ParameterChannel after(@Nonnull TimeDuration delay);

    /**
     * {@inheritDoc}
     */
    @Nonnull
    ParameterChannel after(long delay, @Nonnull TimeUnit timeUnit);

    /**
     * {@inheritDoc}
     */
    @Nonnull
    ParameterChannel now();

    /**
     * {@inheritDoc}
     */
    @Nonnull
    ParameterChannel pass(@Nullable OutputChannel channel);

    /**
     * {@inheritDoc}
     */
    @Nonnull
    ParameterChannel pass(@Nullable Iterable inputs);

    /**
     * {@inheritDoc}
     */
    @Nonnull
    ParameterChannel pass(@Nullable INPUT input);

    /**
     * {@inheritDoc}
     */
    @Nonnull
    ParameterChannel pass(@Nullable INPUT... inputs);

    /**
     * Closes the input channel and returns the output one.
     *
     * @return the routine output channel.
     * @throws com.gh.bmd.jrt.common.RoutineException if the execution has been aborted.
     * @throws java.lang.IllegalStateException        if this channel is already closed.
     */
    @Nonnull
    OutputChannel result();
}