org.robovm.objc.annotation

Annotation Type Block

@Retention(value=RUNTIME)
 @Target(value={PARAMETER,METHOD})
public @interface Block

Used to mark a method parameter or method return type as a block type. The type of the parameter must be a functional interface with a single abstract method, e.g. Runnable, Callable or any of the block interfaces in the org.robovm.objc.block package. The RoboVM compiler will generate a Marshaler class which will be used to marshal the block type.

The interface type can be a generic type such as Callable. The RoboVM compiler will resolve the actual type arguments from the method parameter or return type and use these in the Callback method signature. Wrapper classes for primitive types like Integer will be boxed/unboxed to their primitive counterpart.

Type modifier annotations such as ByVal and Pointer can be specified as the value() of the Block annotation. The syntax is:

   RetAnno1 RetAnno2 (ParamAnno1_1 ParamAnno1_2 ..., ParamAnno2_1, ...)

Recognized annotations are ByVal, ByRef, Pointer, MachineSizedFloat, MachineSizedSInt, MachineSizedUInt and Block.

Examples:
void (^)(void) => @Block Runnable
void (^)(BOOL) => @Block VoidBooleanBlock
CGRect (^)(long, char) => @Block("@ByVal (@MachineSizedSInt,)") Block1<Long, Byte, CGRect>

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	value Specifies return and parameter annotations for the method in the target interface.

Element Detail

value

public abstract String value

Specifies return and parameter annotations for the method in the target interface. See Block for the syntax of this value. The default is an empty string which means that no annotations will be applied.

Default:

""