Module com.google.j2objc.annotations

Package com.google.j2objc.annotations

Annotation Type ObjectiveCAdapterMethod

@Documented
@Target(METHOD)
@Retention(CLASS)
public @interface ObjectiveCAdapterMethod

Annotation applicable to methods that generates a peer "adapter" method in the transpiled class or interface. Adapter methods can provide one or more "adaptations" to the generated method, which change the types and behavior of the annotated ("adapted") method.

Adapter methods are intended to reduce friction between native and J2ObjC interfaces, and improve type information and safety. For example, using the EXCEPTIONS_AS_ERRORS adaptation allows Java methods that throw exceptions to be safely called from Objective-C and Swift without needing to catch exceptions in Objective-C (exceptions cannot be caught in Swift).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ObjectiveCAdapterMethod.Adaptation	Specific adaptations applied by the annotation.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
ObjectiveCAdapterMethod.Adaptation[]	adaptations	List of adaptations the adapter method will use.
String	selector	The Objective-C selector to use for the adapter method.

Element Details

selector

String selector

The Objective-C selector to use for the adapter method. Has the same naming requirements as the ObjectiveCName annotation for methods. This field is required.

Default:

""

adaptations

ObjectiveCAdapterMethod.Adaptation[] adaptations

List of adaptations the adapter method will use.

Default:

{}