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

Commit 8c2c82d3 authored by Kevin Jeon's avatar Kevin Jeon
Browse files

Discourage methods that use resource reflection 

This change adds the @Discouraged annotation to methods that access
resources by name (getIdentifier() and getValue()). Users will be
directed to retrieve resources by identifier instead.

Bug: 202194091
Test: Checked that getIdentifier() and getValue() raise lint warnings.
Change-Id: Ib69797bf9ccf9e336326a3925fb6409048b647ad
parent 2e7d9776

core/api/current.txt

+2 −2
Original line number Diff line number Diff line
@@ -13453,7 +13453,7 @@ package android.content.res { 
    method public float getFloat(@DimenRes int);

    method @NonNull public android.graphics.Typeface getFont(@FontRes int) throws android.content.res.Resources.NotFoundException;

    method public float getFraction(@FractionRes int, int, int);

    method public int getIdentifier(String, String, String);

    method @Discouraged(message="Use of this function is discouraged because resource reflection makes it harder to perform build optimizations and compile-time verification of code. It is much more efficient to retrieve resources by identifier (e.g. `R.foo.bar`) than by name (e.g. `getIdentifier(\"bar\", \"foo\", null)`).") public int getIdentifier(String, String, String);

    method @NonNull public int[] getIntArray(@ArrayRes int) throws android.content.res.Resources.NotFoundException;

    method public int getInteger(@IntegerRes int) throws android.content.res.Resources.NotFoundException;

    method @NonNull public android.content.res.XmlResourceParser getLayout(@LayoutRes int) throws android.content.res.Resources.NotFoundException;
@@ -13473,7 +13473,7 @@ package android.content.res { 
    method public CharSequence getText(@StringRes int, CharSequence);

    method @NonNull public CharSequence[] getTextArray(@ArrayRes int) throws android.content.res.Resources.NotFoundException;

    method public void getValue(@AnyRes int, android.util.TypedValue, boolean) throws android.content.res.Resources.NotFoundException;

    method public void getValue(String, android.util.TypedValue, boolean) throws android.content.res.Resources.NotFoundException;

    method @Discouraged(message="Use of this function is discouraged because it makes internal calls to `getIdentifier()`, which uses resource reflection. Reflection makes it harder to perform build optimizations and compile-time verification of code. It is much more efficient to retrieve resource values by identifier (e.g. `getValue(R.foo.bar, outValue, true)`) than by name (e.g. `getValue(\"foo\", outvalue, true)`).") public void getValue(String, android.util.TypedValue, boolean) throws android.content.res.Resources.NotFoundException;

    method public void getValueForDensity(@AnyRes int, int, android.util.TypedValue, boolean) throws android.content.res.Resources.NotFoundException;

    method @NonNull public android.content.res.XmlResourceParser getXml(@XmlRes int) throws android.content.res.Resources.NotFoundException;

    method public final android.content.res.Resources.Theme newTheme();

core/java/android/content/res/Resources.java

+12 −0
Original line number Diff line number Diff line
@@ -27,6 +27,7 @@ import android.annotation.BoolRes; 
import android.annotation.ColorInt;

import android.annotation.ColorRes;

import android.annotation.DimenRes;

import android.annotation.Discouraged;

import android.annotation.DrawableRes;

import android.annotation.FontRes;

import android.annotation.FractionRes;
@@ -1466,6 +1467,12 @@ public class Resources { 
     * @throws NotFoundException Throws NotFoundException if the given ID does not exist.

     *

     */

    @Discouraged(message = "Use of this function is discouraged because it makes internal calls to "

                         + "`getIdentifier()`, which uses resource reflection. Reflection makes it "

                         + "harder to perform build optimizations and compile-time verification of "

                         + "code. It is much more efficient to retrieve resource values by "

                         + "identifier (e.g. `getValue(R.foo.bar, outValue, true)`) than by name "

                         + "(e.g. `getValue(\"foo\", outvalue, true)`).")

    public void getValue(String name, TypedValue outValue, boolean resolveRefs)

            throws NotFoundException {

        mResourcesImpl.getValue(name, outValue, resolveRefs);
@@ -2198,6 +2205,11 @@ public class Resources { 
     * @return int The associated resource identifier.  Returns 0 if no such

     *         resource was found.  (0 is not a valid resource ID.)

     */

    @Discouraged(message = "Use of this function is discouraged because resource reflection makes "

                         + "it harder to perform build optimizations and compile-time "

                         + "verification of code. It is much more efficient to retrieve "

                         + "resources by identifier (e.g. `R.foo.bar`) than by name (e.g. "

                         + "`getIdentifier(\"bar\", \"foo\", null)`).")

    public int getIdentifier(String name, String defType, String defPackage) {

        return mResourcesImpl.getIdentifier(name, defType, defPackage);

    }