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

import com.gh.bmd.jrt.android.service.RoutineService;
import com.gh.bmd.jrt.builder.RoutineBuilder;
import com.gh.bmd.jrt.builder.RoutineConfiguration;
import com.gh.bmd.jrt.log.Log;
import com.gh.bmd.jrt.runner.Runner;

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

/**
 * Interface defining a builder of routine objects based on an invocation class token.

 * The invocation execution will happen in a dedicated service.
 * 
 * The local context of the invocations will be the specific service instance.
 * 

 * Created by davide on 3/7/15.
 *
 * @param   the input data type.
 * @param  the output data type.
 */
public interface InvocationServiceRoutineBuilder
        extends ServiceRoutineBuilder, RoutineBuilder {

    /**
     * {@inheritDoc}
     */
    @Nonnull
    InvocationServiceRoutineBuilder dispatchingOn(@Nullable Looper looper);

    /**
     * {@inheritDoc}
     */
    @Nonnull
    InvocationServiceRoutineBuilder withLogClass(
            @Nullable Class logClass);

    /**
     * {@inheritDoc}
     */
    @Nonnull
    InvocationServiceRoutineBuilder withRunnerClass(
            @Nullable Class runnerClass);

    /**
     * {@inheritDoc}
     */
    @Nonnull
    InvocationServiceRoutineBuilder withServiceClass(
            @Nullable Class serviceClass);

    /**
     * Sets the arguments to be passed to the invocation constructor.
     * 
     * Note that, like the object passed to the service routine input and output channels, the
     * specified arguments must comply with the {@link android.os.Parcel#writeValue(Object)} method.
     * Be aware though, that issues may arise when employing {@link java.io.Serializable} objects on
     * the Lollipop OS version, so, it is advisable to use {@link android.os.Parcelable} objects
     * instead.
     *
     * @param args the arguments.
     * @return this builder.
     */
    @Nonnull
    InvocationServiceRoutineBuilder withArgs(@Nullable Object... args);

    /**
     * {@inheritDoc}
     */
    @Nonnull
    InvocationServiceRoutineBuilder withConfiguration(
            @Nullable RoutineConfiguration configuration);
}