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

import com.github.dm.jrt.builder.InvocationConfiguration.Builder;
import com.github.dm.jrt.builder.InvocationConfiguration.Configurable;
import com.github.dm.jrt.channel.InvocationChannel;
import com.github.dm.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-maestroni on 03/16/2015.
 *
 * @param   the input data type.
 * @param  the output data type.
 */
public abstract class TemplateRoutineBuilder extends TemplateRoutine
        implements RoutineBuilder, Configurable> {

    private InvocationConfiguration mConfiguration = InvocationConfiguration.DEFAULT_CONFIGURATION;

    @Nonnull
    public InvocationChannel asyncInvoke() {

        return buildRoutine().asyncInvoke();
    }

    @Nonnull
    public InvocationChannel parallelInvoke() {

        return buildRoutine().parallelInvoke();
    }

    @Nonnull
    public InvocationChannel syncInvoke() {

        return buildRoutine().syncInvoke();
    }

    @Nonnull
    public Builder> invocations() {

        return new Builder>(this, mConfiguration);
    }

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

        if (configuration == null) {

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

        mConfiguration = configuration;
        return this;
    }

    /**
     * Returns the invocation configuration.
     *
     * @return the configuration.
     */
    @Nonnull
    protected InvocationConfiguration getConfiguration() {

        return mConfiguration;
    }
}