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

Commit 32c5cfb2 authored by Kweku Adams's avatar Kweku Adams
Browse files

Improve API signature. 

There's nothing actionable for someone calling addToWhitelist() if the
addition fails (since it means the package wasn't found), so there's no
reason to have a return value. Removing the return value and clarifying
that calling the API will add the app to the permanent power save
whitelist.

Bug: 149216029
Test: atest PowerWhitelistTest
Change-Id: I54da34703c9f8862fa641f6b0313e6dfa37948e7
parent 223c27ef

apex/jobscheduler/framework/java/android/os/PowerWhitelistManager.java

+6 −11
Original line number Diff line number Diff line
@@ -80,27 +80,22 @@ public class PowerWhitelistManager { 
    }



    /**

     * Add the specified package to the power save whitelist.

     *

     * @return true if the package was successfully added to the whitelist

     * Add the specified package to the permanent power save whitelist.

     */

    @RequiresPermission(android.Manifest.permission.DEVICE_POWER)

    public boolean addToWhitelist(@NonNull String packageName) {

        return addToWhitelist(Collections.singletonList(packageName)) == 1;

    public void addToWhitelist(@NonNull String packageName) {

        addToWhitelist(Collections.singletonList(packageName));

    }



    /**

     * Add the specified packages to the power save whitelist.

     *

     * @return the number of packages that were successfully added to the whitelist

     * Add the specified packages to the permanent power save whitelist.

     */

    @RequiresPermission(android.Manifest.permission.DEVICE_POWER)

    public int addToWhitelist(@NonNull List<String> packageNames) {

    public void addToWhitelist(@NonNull List<String> packageNames) {

        try {

            return mService.addPowerSaveWhitelistApps(packageNames);

            mService.addPowerSaveWhitelistApps(packageNames);

        } catch (RemoteException e) {

            e.rethrowFromSystemServer();

            return 0;

        }

    }

api/system-current.txt

+2 −2
Original line number Diff line number Diff line
@@ -8838,8 +8838,8 @@ package android.os { 
  }















  public class PowerWhitelistManager {













    method @RequiresPermission(android.Manifest.permission.DEVICE_POWER) public boolean addToWhitelist(@NonNull String);













    method @RequiresPermission(android.Manifest.permission.DEVICE_POWER) public int addToWhitelist(@NonNull java.util.List<java.lang.String>);













    method @RequiresPermission(android.Manifest.permission.DEVICE_POWER) public void addToWhitelist(@NonNull String);













    method @RequiresPermission(android.Manifest.permission.DEVICE_POWER) public void addToWhitelist(@NonNull java.util.List<java.lang.String>);















    method @RequiresPermission(android.Manifest.permission.CHANGE_DEVICE_IDLE_TEMP_WHITELIST) public void whitelistAppTemporarily(@NonNull String, long);















    method @RequiresPermission(android.Manifest.permission.CHANGE_DEVICE_IDLE_TEMP_WHITELIST) public long whitelistAppTemporarilyForEvent(@NonNull String, int, @NonNull String);















    field public static final int EVENT_MMS = 2; // 0x2

























api/test-current.txt



+2
−2




























Original line number
Diff line number
Diff line








@@ -2450,8 +2450,8 @@ package android.os {













  }































  public class PowerWhitelistManager {













    method @RequiresPermission("android.permission.DEVICE_POWER") public boolean addToWhitelist(@NonNull String);













    method @RequiresPermission("android.permission.DEVICE_POWER") public int addToWhitelist(@NonNull java.util.List<java.lang.String>);













    method @RequiresPermission("android.permission.DEVICE_POWER") public void addToWhitelist(@NonNull String);













    method @RequiresPermission("android.permission.DEVICE_POWER") public void addToWhitelist(@NonNull java.util.List<java.lang.String>);















    method @RequiresPermission("android.permission.CHANGE_DEVICE_IDLE_TEMP_WHITELIST") public void whitelistAppTemporarily(@NonNull String, long);















    method @RequiresPermission("android.permission.CHANGE_DEVICE_IDLE_TEMP_WHITELIST") public long whitelistAppTemporarilyForEvent(@NonNull String, int, @NonNull String);















    field public static final int EVENT_MMS = 2; // 0x2