com.gh.bmd.jrt.android.v4.routine.InvocationResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jroutine-android Show documentation

Parallel programming on the go

There is a newer version: 6.0.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.android.v4.routine;

import com.gh.bmd.jrt.channel.StandaloneChannel.StandaloneInput;

import java.util.Collection;

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

/**
 * Interface defining an Android invocation result.
 * 
 * Created by davide on 1/4/15.
 *
 * @param  the output data type.
 */
interface InvocationResult {

    /**
     * Returns the abort exception.
     *
     * @return the exception.
     */
    @Nullable
    Throwable getAbortException();

    /**
     * Checks if this result represents an error.
     *
     * @return whether the result is an error.
     */
    boolean isError();

    /**
     * Passes the cached results to the specified channels.
     *
     * @param newChannels new channels freshly created.
     * @param oldChannels old channels already fed with previous results.
     * @return whether the invocation is complete.
     * @throws java.lang.NullPointerException if any of the parameters is null.
     */
    boolean passTo(@Nonnull final Collection> newChannels,
            @Nonnull final Collection> oldChannels);
}