com.gh.bmd.jrt.processor.builder.WrapperRoutineBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jroutine-processor 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.processor.builder;

import com.gh.bmd.jrt.builder.RoutineConfiguration;
import com.gh.bmd.jrt.common.ClassToken;
import com.gh.bmd.jrt.routine.SharableBuilder;

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

/**
 * Interface defining a builder of routines wrapping an object instance.
 * 
 * Note that only instance methods can be asynchronously invoked through the routines created by
 * this builder.
 * 

 * Created by davide on 3/7/15.
 *
 * @see com.gh.bmd.jrt.annotation.Bind
 * @see com.gh.bmd.jrt.annotation.Pass
 * @see com.gh.bmd.jrt.annotation.Share
 * @see com.gh.bmd.jrt.annotation.Timeout
 * @see com.gh.bmd.jrt.processor.annotation.Wrap
 */
public interface WrapperRoutineBuilder extends SharableBuilder {

    /**
     * Returns a wrapper 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}
     * and {@link com.gh.bmd.jrt.annotation.Pass} annotations.

     * Note that such annotations will override any configuration set through the builder.
     * 

     * The wrapping object is created through code generation based on the interfaces annotated
     * with {@link com.gh.bmd.jrt.processor.annotation.Wrap}. The generated class will share the
     * same package of the specified interface and will have a name of the type:
     * JRoutine_<itf_simple_name>
     * 

     * It is actually possible to avoid the use of reflection for the wrapper instantiation by
     * explicitly calling the JRoutine_<itf_simple_name>.on() method. Note,
     * however, that, since the class is generated, a generic IDE may highlight an error even if the
     * compilation is successful.
     * 

     * Note also that you'll need to enable annotation pre-processing by adding the processor
     * artifact to the specific project dependencies.
     *
     * @param itf    the interface implemented by the return object.
     * @param  the interface type.
     * @return the wrapping object.
     * @throws IllegalArgumentException if the specified class does not represent an
     *                                  interface.
     * @throws NullPointerException     if the specified class is null.
     */
    @Nonnull
     TYPE buildWrapper(@Nonnull Class itf);

    /**
     * Returns a wrapper 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}
     * and {@link com.gh.bmd.jrt.annotation.Pass} annotations.

     * Note that such annotations will override any configuration set through the builder.
     * 
     * The wrapping object is created through code generation based on the interfaces annotated
     * with {@link com.gh.bmd.jrt.processor.annotation.Wrap}. The generated class will share the
     * same package of the specified interface and will have a name of the type:
     * JRoutine_<itf_simple_name>
     * 

     * It is actually possible to avoid the use of reflection for the wrapper instantiation by
     * explicitly calling the JRoutine_<itf_simple_name>.on() method. Note,
     * however, that, since the class is generated, a generic IDE may highlight an error even if the
     * compilation is successful.
     * 

     * Note also that you'll need to enable annotation pre-processing by adding the processor
     * artifact to the specific project dependencies.
     *
     * @param itf    the token of the interface implemented by the return object.
     * @param  the interface type.
     * @return the wrapping object.
     * @throws IllegalArgumentException if the specified class does not represent an
     *                                  interface.
     * @throws NullPointerException     if the specified class is null.
     */
    @Nonnull
     TYPE buildWrapper(@Nonnull ClassToken itf);

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

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