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

Commit 5706a1b1 authored by Clara Bayarri's avatar Clara Bayarri
Browse files

Update Typeface callback docs about error codes 

As requested by API council, mention that the provider may
return its own error codes within the positive int range.

Bug: 37084803
Test: none
Change-Id: Ia8ee99432cc5025a12d43049e327605095dd2b57
parent 4132f860

core/java/android/provider/FontsContract.java

+7 −3
Original line number Original line Diff line number Diff line
@@ -124,8 +124,9 @@ public class FontsContract { 
         * should have this column populated to indicate the result status of the

         * should have this column populated to indicate the result status of the

         * query. This will be checked before any other data in the cursor. Possible values are

         * query. This will be checked before any other data in the cursor. Possible values are

         * {@link #RESULT_CODE_OK}, {@link #RESULT_CODE_FONT_NOT_FOUND},

         * {@link #RESULT_CODE_OK}, {@link #RESULT_CODE_FONT_NOT_FOUND},

         * {@link #RESULT_CODE_MALFORMED_QUERY} and {@link #RESULT_CODE_FONT_UNAVAILABLE}. If not

         * {@link #RESULT_CODE_MALFORMED_QUERY} and {@link #RESULT_CODE_FONT_UNAVAILABLE} for system

         * present, {@link #RESULT_CODE_OK} will be assumed.

         * defined values. You may also define your own values in the 0x000010000..0xFFFF0000 range.

         * If not present, {@link #RESULT_CODE_OK} will be assumed.

         */

         */

        public static final String RESULT_CODE = "result_code";

        public static final String RESULT_CODE = "result_code";
@@ -452,7 +453,10 @@ public class FontsContract { 
         *               {@link #FAIL_REASON_FONT_NOT_FOUND},

         *               {@link #FAIL_REASON_FONT_NOT_FOUND},

         *               {@link #FAIL_REASON_FONT_LOAD_ERROR},

         *               {@link #FAIL_REASON_FONT_LOAD_ERROR},

         *               {@link #FAIL_REASON_FONT_UNAVAILABLE} or

         *               {@link #FAIL_REASON_FONT_UNAVAILABLE} or

         *               {@link #FAIL_REASON_MALFORMED_QUERY}.

         *               {@link #FAIL_REASON_MALFORMED_QUERY} if returned by the system. May also be

         *               a positive value greater than 0 defined by the font provider as an

         *               additional error code. Refer to the provider's documentation for more

         *               information on possible returned error codes.

         */

         */

        public void onTypefaceRequestFailed(@FontRequestFailReason int reason) {}

        public void onTypefaceRequestFailed(@FontRequestFailReason int reason) {}

    }

    }

graphics/java/android/graphics/Typeface.java

+5 −2
Original line number Original line Diff line number Diff line
@@ -475,11 +475,14 @@ public class Typeface { 
        /**

        /**

         * Called when a Typeface request done via {@link Typeface#create(FontRequest,

         * Called when a Typeface request done via {@link Typeface#create(FontRequest,

         * FontRequestCallback)} fails.

         * FontRequestCallback)} fails.

         * @param reason One of {@link #FAIL_REASON_PROVIDER_NOT_FOUND},

         * @param reason May be one of {@link #FAIL_REASON_PROVIDER_NOT_FOUND},

         *               {@link #FAIL_REASON_FONT_NOT_FOUND},

         *               {@link #FAIL_REASON_FONT_NOT_FOUND},

         *               {@link #FAIL_REASON_FONT_LOAD_ERROR},

         *               {@link #FAIL_REASON_FONT_LOAD_ERROR},

         *               {@link #FAIL_REASON_FONT_UNAVAILABLE} or

         *               {@link #FAIL_REASON_FONT_UNAVAILABLE} or

         *               {@link #FAIL_REASON_MALFORMED_QUERY}.

         *               {@link #FAIL_REASON_MALFORMED_QUERY} if returned by the system. May also be

         *               a positive value greater than 0 defined by the font provider as an

         *               additional error code. Refer to the provider's documentation for more

         *               information on possible returned error codes.

         */

         */

        void onTypefaceRequestFailed(@FontRequestFailReason int reason);

        void onTypefaceRequestFailed(@FontRequestFailReason int reason);

    }

    }