com.github.dm.jrt.annotation

Annotation Type Input

@Target(value=PARAMETER)
@Retention(value=RUNTIME)
public @interface Input

Through this annotation it is possible to indicate the original parameter type of the target object method.

The only use case in which this annotation is useful, is when an interface is used as a proxy of another class methods. The interface can take some input parameters in an asynchronous way. In such case, the value specified in the annotation will indicate the type of the parameter expected by the target method.

For example, a method taking two integers:

     

         public int sum(int i1, int i2);
     
 

can be proxied by a method defined as:

     

         public int sum(@Input(int.class) OutputChannel<Integer> i1, int i2);
     
 

Note that the transfer mode is specifically chosen through the annotation mode attribute (it's CHANNEL by default).

This annotation is used to decorate methods that are to be invoked in an asynchronous way.
Note that the piece of code inside such methods will be automatically protected so to avoid concurrency issues. Though, other parts of the code inside the same class will be not.
In order to prevent unexpected behaviors, it is advisable to avoid using the same class fields (unless immutable) in protected and non-protected code, or to call synchronous methods through routines as well.

Remember also that, in order for the annotation to properly work at run time, you will need to add the following rules to your Proguard file (if employing it for shrinking or obfuscation):

     

         -keepattributes RuntimeVisibleAnnotations
         -keepclassmembers class ** {
              @com.github.dm.jrt.annotation.Input *;
         }
     
 

Created by davide-maestroni on 05/23/2015.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<?>	value The parameter class.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Input.InputMode	mode The input transfer mode.

Element Detail

value

public abstract Class<?> value

The parameter class.

Returns:

the class.

mode

public abstract Input.InputMode mode

The input transfer mode.

Returns:

the mode.

Default:

com.github.dm.jrt.annotation.Input.InputMode.CHANNEL