com.gh.bmd.jrt.invocation.FunctionInvocation 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.invocation;

import com.gh.bmd.jrt.channel.ResultChannel;

import java.util.ArrayList;
import java.util.List;

import javax.annotation.Nonnull;

/**
 * This is a special abstract implementation that centralizes the routine invocation inside a
 * single method, which gets called only when all the inputs are available.
 * 
 * The implementing class may additionally override the invocation methods to specifically handle
 * the object lifecycle. Note anyway that the superclass must be invoked in order to properly work.
 * 
 * Created by davide-maestroni on 9/7/14.
 *
 * @param   the input data type.
 * @param  the output data type.
 */
public abstract class FunctionInvocation extends TemplateInvocation {

    private ArrayList mInputs;

    @Override
    public void onInput(final INPUT input, @Nonnull final ResultChannel result) {

        if (mInputs == null) {

            mInputs = new ArrayList();
        }

        mInputs.add(input);
    }

    @Override
    public void onResult(@Nonnull final ResultChannel result) {

        final ArrayList inputs = mInputs;
        final ArrayList clone;

        if (inputs == null) {

            clone = new ArrayList(0);

        } else {

            clone = new ArrayList(inputs);
        }

        onCall(clone, result);
    }

    @Override
    public void onTerminate() {

        final ArrayList inputs = mInputs;

        if (inputs != null) {

            inputs.clear();
        }
    }

    /**
     * This method is called when all the inputs are available and ready to be processed.
     *
     * @param inputs the input list.
     * @param result the result channel.
     */
    protected abstract void onCall(@Nonnull List inputs,
            @Nonnull ResultChannel result);
}