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

import com.gh.bmd.jrt.android.routine.ContextRoutine;
import com.gh.bmd.jrt.builder.RoutineBuilder;
import com.gh.bmd.jrt.builder.RoutineConfiguration;

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

/**
 * Interface defining a builder of routines bound to a context lifecycle.
 * 
 * Routine invocations started through the returned objects can be safely restored after a change in
 * the configuration, so to avoid duplicated calls and memory leaks. Be aware, though, that the
 * invocation results will always be dispatched in the main thread, no matter the calling one was,
 * so, waiting for the outputs right after the routine invocation, will result in a deadlock.

 * The local context of the invocations will always be the application one.
 * 
 * Created by davide on 12/9/14.
 *
 * @param   the input data type.
 * @param  the output data type.
 */
public interface InvocationContextRoutineBuilder
        extends ContextRoutineBuilder, RoutineBuilder,
        ContextRoutine {

    /**
     * {@inheritDoc}
     */
    @Nonnull
    ContextRoutine buildRoutine();

    /**
     * Note that all the options related to the output and input channels size and timeout will be
     * ignored.
     *
     * @param configuration the routine configuration.
     * @return this builder.
     */
    @Nonnull
    InvocationContextRoutineBuilder withConfiguration(
            @Nullable RoutineConfiguration configuration);

    /**
     * {@inheritDoc}
     */
    @Nonnull
    InvocationContextRoutineBuilder onClash(
            @Nullable ClashResolutionType resolutionType);

    /**
     * {@inheritDoc}
     */
    @Nonnull
    InvocationContextRoutineBuilder onComplete(
            @Nullable CacheStrategyType strategyType);

    /**
     * {@inheritDoc}
     */
    @Nonnull
    InvocationContextRoutineBuilder withArgs(@Nullable Object... args);

    /**
     * {@inheritDoc}
     */
    @Nonnull
    InvocationContextRoutineBuilder withId(int invocationId);
}