com.gh.bmd.jrt.android.builder.ObjectContextRoutineBuilder 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.builder.ObjectRoutineBuilder;
import com.gh.bmd.jrt.builder.RoutineConfiguration;
import com.gh.bmd.jrt.common.ClassToken;
import com.gh.bmd.jrt.routine.Routine;

import java.lang.reflect.Method;

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

/**
 * Class implementing a builder of routine objects based on methods of a concrete object instance.
 * 
 * The single methods can be accessed via reflection or the whole instance can be proxied through
 * an interface.
 * 

 * Created by Davide on 4/6/2015.
 */
public interface ObjectContextRoutineBuilder extends ContextRoutineBuilder, ObjectRoutineBuilder {

    /**
     * Returns a routine used to call the method whose identifying name is specified in a
     * {@link com.gh.bmd.jrt.annotation.Bind} annotation.

     * Optional {@link com.gh.bmd.jrt.annotation.Timeout},
     * {@link com.gh.bmd.jrt.annotation.TimeoutAction},
     * {@link com.gh.bmd.jrt.annotation.ShareGroup}, as well as
     * {@link com.gh.bmd.jrt.android.annotation.CacheStrategy},
     * {@link com.gh.bmd.jrt.android.annotation.ClashResolution} and
     * {@link com.gh.bmd.jrt.android.annotation.Id} method annotations will be honored.

     * Note that such annotations will override any configuration set through the builder.
     *
     * @param name     the name specified in the annotation.
     * @param   the input data type.
     * @param  the output data type.
     * @return the routine.
     * @throws java.lang.IllegalArgumentException if the specified method is not found.
     */
    @Nonnull
     Routine boundMethod(@Nonnull String name);

    /**
     * Returns a routine used to call the specified method.
     * 

     * The method is searched via reflection ignoring a name specified in a
     * {@link com.gh.bmd.jrt.annotation.Bind} annotation. Though, optional
     * {@link com.gh.bmd.jrt.annotation.Timeout}, {@link com.gh.bmd.jrt.annotation.TimeoutAction},
     * {@link com.gh.bmd.jrt.annotation.ShareGroup}, as well as
     * {@link com.gh.bmd.jrt.android.annotation.CacheStrategy},
     * {@link com.gh.bmd.jrt.android.annotation.ClashResolution} and
     * {@link com.gh.bmd.jrt.android.annotation.Id} method annotations will be honored.

     * Note that such annotations will override any configuration set through the builder.
     *
     * @param name           the method name.
     * @param parameterTypes the method parameter types.
     * @return the routine.
     * @throws java.lang.IllegalArgumentException if no matching method is found.
     * @throws java.lang.NullPointerException     if one of the parameter is null.
     */
    @Nonnull
     Routine method(@Nonnull String name,
            @Nonnull Class... parameterTypes);

    /**
     * Returns a routine used to call the specified method.
     * 

     * The method is invoked ignoring a name specified in a
     * {@link com.gh.bmd.jrt.annotation.Bind} annotation. Though, optional
     * {@link com.gh.bmd.jrt.annotation.ShareGroup}, as well as
     * {@link com.gh.bmd.jrt.android.annotation.CacheStrategy},
     * {@link com.gh.bmd.jrt.android.annotation.ClashResolution} and
     * {@link com.gh.bmd.jrt.android.annotation.Id} method annotations will be honored.

     * Note that such annotations will override any configuration set through the builder.
     *
     * @param method   the method instance.
     * @param   the input data type.
     * @param  the output data type.
     * @return the routine.
     * @throws java.lang.NullPointerException if the specified method is null.
     */
    @Nonnull
     Routine method(@Nonnull Method method);

    /**
     * Returns a proxy object enabling asynchronous calling of the target instance methods.
     * 

     * The routines used for calling the methods will honor the attributes specified in any
     * optional {@link com.gh.bmd.jrt.annotation.Bind}, {@link com.gh.bmd.jrt.annotation.Timeout},
     * {@link com.gh.bmd.jrt.annotation.TimeoutAction},
     * {@link com.gh.bmd.jrt.annotation.ShareGroup}, as well as
     * {@link com.gh.bmd.jrt.android.annotation.CacheStrategy},
     * {@link com.gh.bmd.jrt.android.annotation.ClashResolution} and
     * {@link com.gh.bmd.jrt.android.annotation.Id} annotations.

     * Note that such annotations will override any configuration set through the builder.
     *
     * @param itf    the token of the interface implemented by the return object.
     * @param  the interface type.
     * @return the proxy object.
     * @throws java.lang.IllegalArgumentException if the specified class token does not represent an
     *                                            interface.
     * @throws java.lang.NullPointerException     if the specified class token is null.
     */
    @Nonnull
     TYPE buildProxy(@Nonnull Class itf);

    /**
     * Returns a proxy object enabling asynchronous calling of the target instance methods.
     * 
     * The routines used for calling the methods will honor the attributes specified in any
     * optional {@link com.gh.bmd.jrt.annotation.Bind}, {@link com.gh.bmd.jrt.annotation.Timeout},
     * {@link com.gh.bmd.jrt.annotation.TimeoutAction},
     * {@link com.gh.bmd.jrt.annotation.ShareGroup}, as well as
     * {@link com.gh.bmd.jrt.android.annotation.CacheStrategy},
     * {@link com.gh.bmd.jrt.android.annotation.ClashResolution} and
     * {@link com.gh.bmd.jrt.android.annotation.Id} annotations.

     * Note that such annotations will override any configuration set through the builder.
     *
     * @param itf    the token of the interface implemented by the return object.
     * @param  the interface type.
     * @return the proxy object.
     * @throws java.lang.IllegalArgumentException if the specified class token does not represent an
     *                                            interface.
     * @throws java.lang.NullPointerException     if the specified class token is null.
     */
    @Nonnull
     TYPE buildProxy(@Nonnull ClassToken itf);

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

    /**
     * {@inheritDoc}
     */
    @Nonnull
    ObjectContextRoutineBuilder withShareGroup(@Nullable String group);

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

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

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

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