com.gh.bmd.jrt.builder.TemplateRoutineBuilder 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.builder;

import com.gh.bmd.jrt.builder.RoutineConfiguration.Builder;
import com.gh.bmd.jrt.builder.RoutineConfiguration.Configurable;
import com.gh.bmd.jrt.channel.ParameterChannel;
import com.gh.bmd.jrt.routine.TemplateRoutine;

import javax.annotation.Nonnull;

/**
 * Empty abstract implementation of a routine builder.
 * 
 * This class is useful to avoid the need of implementing some of the methods defined in the
 * interface.
 * Created by davide on 3/16/15.
 *
 * @param   the input data type.
 * @param  the output data type.
 */
public abstract class TemplateRoutineBuilder extends TemplateRoutine
        implements RoutineBuilder, Configurable> {

    private RoutineConfiguration mConfiguration = RoutineConfiguration.DEFAULT_CONFIGURATION;

    @Nonnull
    public ParameterChannel invokeAsync() {

        return buildRoutine().invokeAsync();
    }

    @Nonnull
    public ParameterChannel invokeParallel() {

        return buildRoutine().invokeParallel();
    }

    @Nonnull
    public ParameterChannel invokeSync() {

        return buildRoutine().invokeSync();
    }

    @Nonnull
    @SuppressWarnings("ConstantConditions")
    public RoutineBuilder setConfiguration(
            @Nonnull final RoutineConfiguration configuration) {

        if (configuration == null) {

            throw new NullPointerException("the configuration must not be null");
        }

        mConfiguration = configuration;
        return this;
    }

    @Nonnull
    public Builder> withRoutine() {

        return new Builder>(this, mConfiguration);
    }

    /**
     * Returns the routine configuration.
     *
     * @return the configuration.
     */
    @Nonnull
    protected RoutineConfiguration getConfiguration() {

        return mConfiguration;
    }
}