com.github.dm.jrt.builder

Interface ObjectRoutineBuilder

All Superinterfaces:

ConfigurableBuilder<ObjectRoutineBuilder>, ProxyConfigurableBuilder<ObjectRoutineBuilder>

public interface ObjectRoutineBuilder
extends ConfigurableBuilder<ObjectRoutineBuilder>, ProxyConfigurableBuilder<ObjectRoutineBuilder>

Interface defining a builder of routines wrapping an object methods.

Created by davide-maestroni on 03/07/2015.

Method Summary

Methods

Modifier and Type	Method and Description
<IN,OUT> Routine<IN,OUT>	aliasMethod(String name) Returns a routine used to call the method whose identifying name is specified in a Alias annotation. Optional com.github.dm.jrt.annotation.* method annotations will be honored as well. Note that such annotations will override any configuration set through the builder.
<TYPE> TYPE	buildProxy(Class<TYPE> itf) Returns a proxy object enabling asynchronous call of the target instance methods.
<TYPE> TYPE	buildProxy(ClassToken<TYPE> itf) Returns a proxy object enabling asynchronous call of the target instance methods.
<IN,OUT> Routine<IN,OUT>	method(Method method) Returns a routine used to call the specified method.
<IN,OUT> Routine<IN,OUT>	method(String name, Class<?>... parameterTypes) Returns a routine used to call the specified method.

Methods inherited from interface com.github.dm.jrt.builder.ConfigurableBuilder

invocations

Methods inherited from interface com.github.dm.jrt.builder.ProxyConfigurableBuilder

proxies

Method Detail

aliasMethod

@NotNull
<IN,OUT> Routine<IN,OUT> aliasMethod(@NotNull
                                           String name)

Returns a routine used to call the method whose identifying name is specified in a Alias annotation.
Optional com.github.dm.jrt.annotation.* method annotations will be honored as well.
Note that such annotations will override any configuration set through the builder.

Note that it is up to the caller to ensure that the input data are passed to the routine in the correct order.

Type Parameters:

IN - the input data type.

OUT - the output data type.

Parameters:

name - the name specified in the annotation.

Returns:

the routine.

Throws:

IllegalArgumentException - if the specified method is not found.

See Also:

Annotations

buildProxy

@NotNull
<TYPE> TYPE buildProxy(@NotNull
                             ClassToken<TYPE> itf)

Returns a proxy object enabling asynchronous call of the target instance methods.

The routines used for calling the methods will honor the attributes specified in any optional com.github.dm.jrt.annotation.* 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 alias 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 proxy of the target object methods, and the optional Input, Inputs, Invoke and Output annotations will be honored.

Type Parameters:

TYPE - the interface type.

Parameters:

itf - the token of the interface implemented by the returned object.

Returns:

the proxy object.

Throws:

IllegalArgumentException - if the specified class token does not represent an interface.

See Also:

Annotations

buildProxy

@NotNull
<TYPE> TYPE buildProxy(@NotNull
                             Class<TYPE> itf)

Returns a proxy object enabling asynchronous call of the target instance methods.

The routines used for calling the methods will honor the attributes specified in any optional com.github.dm.jrt.annotation.* 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 alias 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 proxy of the target object methods, and the optional Input, Inputs, Invoke and Output annotations will be honored.

Type Parameters:

TYPE - the interface type.

Parameters:

itf - the interface implemented by the returned object.

Returns:

the proxy object.

Throws:

IllegalArgumentException - if the specified class does not represent an interface.

See Also:

Annotations

method

@NotNull
<IN,OUT> Routine<IN,OUT> method(@NotNull
                                      String name,
                                      @NotNull
                                      Class<?>... parameterTypes)

Returns a routine used to call the specified method.

The method is searched via reflection ignoring a name specified in a Alias annotation. Though, optional com.github.dm.jrt.annotation.* method annotations will be honored.
Note that such annotations will override any configuration set through the builder.

Note that it is up to the caller to ensure that the input data are passed to the routine in the correct order.

Parameters:

name - the method name.

parameterTypes - the method parameter types.

Returns:

the routine.

Throws:

IllegalArgumentException - if no matching method is found.

See Also:

Annotations

method

@NotNull
<IN,OUT> Routine<IN,OUT> method(@NotNull
                                      Method method)

Returns a routine used to call the specified method.

The method is invoked ignoring a name specified in a Alias annotation. Though, optional com.github.dm.jrt.annotation.* method annotations will be honored.
Note that such annotations will override any configuration set through the builder.

Note that it is up to the caller to ensure that the input data are passed to the routine in the correct order.

Type Parameters:

IN - the input data type.

OUT - the output data type.

Parameters:

method - the method instance.

Returns:

the routine.

See Also:

Annotations