From d85574cea5ced07ed5e8c6b6007783fe4a9e9564 Mon Sep 17 00:00:00 2001 From: Martin Kretzschmar Date: Thu, 19 Jan 2023 09:57:15 -0800 Subject: [PATCH] Add a J2CL version of `@ObjectiveCName` with retention policy `RUNTIME` The J2CL-based transpilers need annotations to have `RUNTIME` retention if the compiler needs to read them from package-info files. Keep `CLASS` retention for J2ObjC and regular Java to avoid emitting actual runtime metadata. PiperOrigin-RevId: 503193215 --- .../j2objc/annotations/ObjectiveCName.java | 51 +++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 annotations/src/main/super-j2cl/com/google/j2objc/annotations/ObjectiveCName.java diff --git a/annotations/src/main/super-j2cl/com/google/j2objc/annotations/ObjectiveCName.java b/annotations/src/main/super-j2cl/com/google/j2objc/annotations/ObjectiveCName.java new file mode 100644 index 0000000000..a8f2105760 --- /dev/null +++ b/annotations/src/main/super-j2cl/com/google/j2objc/annotations/ObjectiveCName.java @@ -0,0 +1,51 @@ +/* + * 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.google.j2objc.annotations; + +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Annotation that specifies what the Objective-C class, protocol, method, + * constructor or package declaration should be when translated. + * + *

For packages add the annotation to the package declaration in a package-info.java file to + * specify the desired package prefix. Alternatively, package prefixes may be specified using the + * {@code --prefix} or {@code --prefixes} flags when invoking j2objc. + * + *

For classes specify the desired Objective-C class name for the translated type. + * + *

For methods specify the desired Objective-C selector for the translated method: + *

+ * @ObjectiveCName("setDateWithYear:month:day:")
+ * public void setDate(int year, int month, int day);
+ * + * @author Tom Ball + */ +@Documented +@Target({ ElementType.TYPE, ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.PACKAGE }) +@Retention(RetentionPolicy.RUNTIME) // J2CL transpiler requirement for package annotations +public @interface ObjectiveCName { + + /** + * The Objective-C name to use for this element. + * + * @return the Objective-C name. + */ + String value(); +}