com.gh.bmd.jrt.builder.ObjectRoutineBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jroutine Show documentation
Show all versions of jroutine Show documentation
Parallel programming on the go
/*
* 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.builder;
import com.gh.bmd.jrt.common.ClassToken;
import javax.annotation.Nonnull;
/**
* 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-maestroni on 3/7/15.
*
* @see com.gh.bmd.jrt.annotation.Alias
* @see com.gh.bmd.jrt.annotation.Param
* @see com.gh.bmd.jrt.annotation.ShareGroup
* @see com.gh.bmd.jrt.annotation.Timeout
* @see com.gh.bmd.jrt.annotation.TimeoutAction
*/
public interface ObjectRoutineBuilder extends ClassRoutineBuilder {
/**
* 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.Alias}, {@link com.gh.bmd.jrt.annotation.Timeout},
* {@link com.gh.bmd.jrt.annotation.TimeoutAction} and
* {@link com.gh.bmd.jrt.annotation.ShareGroup} annotations.
* Note that such annotations will override any configuration set through the builder.
*
* In case the wrapped object does not implement the specified interface, the binding annotation
* value will be used to bind the interface method with the instance ones. If no annotation is
* present, the method name will be used instead.
* The interface will be interpreted as a mirror of the target object methods, and the optional
* {@link com.gh.bmd.jrt.annotation.Param} annotations will be honored.
*
* @param itf the interface implemented by the return object.
* @param the interface type.
* @return the proxy object.
* @throws java.lang.IllegalArgumentException if the specified class does not represent an
* interface.
*/
@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.Alias}, {@link com.gh.bmd.jrt.annotation.Timeout},
* {@link com.gh.bmd.jrt.annotation.TimeoutAction} and
* {@link com.gh.bmd.jrt.annotation.ShareGroup} annotations.
* Note that such annotations will override any configuration set through the builder.
*
* In case the wrapped object does not implement the specified interface, the binding annotation
* value will be used to bind the interface method with the instance ones. If no annotation is
* present, the method name will be used instead.
* The interface will be interpreted as a mirror of the target object methods, and the optional
* {@link com.gh.bmd.jrt.annotation.Param} annotations will be honored.
*
* @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.
*/
@Nonnull
TYPE buildProxy(@Nonnull ClassToken itf);
/**
* {@inheritDoc}
*/
@Nonnull
ProxyConfiguration.Builder withProxy();
/**
* {@inheritDoc}
*/
@Nonnull
RoutineConfiguration.Builder withRoutine();
}