Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 75025048 authored by Andrei Onea's avatar Andrei Onea
Browse files

Add publicAlternatives to @UnsupportedAppUsage 

Add a new field to UnsupportedAppUsage, to allow specifying public API
alternatives to hidden APIs. This change mirrors the one in libcore.

Bug: 130721457
Test: m
Change-Id: I12592db123fab1ced2d62fbf507c13cade0ef0ba
parent 5c47b52b

core/java/android/annotation/UnsupportedAppUsage.java

+26 −0
Original line number Diff line number Diff line
@@ -124,6 +124,32 @@ public @interface UnsupportedAppUsage { 
     */

    String implicitMember() default "";



    /**

     * Public API alternatives to this API.

     *

     * <p>If non-empty, the string must be a description of the public API alternative(s) to this

     * API. The explanation must contain at least one Javadoc link tag to public API methods or

     * fields. e.g.:

     * {@literal @UnsupportedAppUsage(publicAlternatives="Use {@link foo.bar.Baz#bat()} instead.")}

     *

     * <p>Any elements that can be deduced can be omitted, e.g.:

     * <ul>

     *      <li>

     *          the class, if it's the same as for the annotated element.

     *      </li>

     *      <li>

     *          the package name, if it's the same as for the annotated element.

     *      </li>

     *      <li>

     *          the method parameters, if there is only one method with that name in the given

     *          package and class.

     *      </li>

     * </ul>

     * @return A Javadoc-formatted string.

     */

    @SuppressWarnings("JavadocReference")

    String publicAlternatives() default "";



    /**

     * Container for {@link UnsupportedAppUsage} that allows it to be applied repeatedly to types.

     */