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

Commit e4bd9524 authored by Soonil Nagarkar's avatar Soonil Nagarkar
Browse files

Update some Nullable annotations on PendingIntent 

It's possible to statically verify that mTarget can never be null, and
that in every instance where an @NonNull annotation has been added here
it was previously impossible for null to be returned at that location.
The only exception is for getCreatorPackage(), where it is more
difficult to verify that it is impossible for this to be null.
Logically, it doesn't make any sense for a PI to not have a creator
package, and I have gone through every call flow for setting the creator
package I could fine to verify it can never be set to null.

Bug: 175221460
Test: manual sanity checks
Change-Id: Ia9e2c3c4ff8c9082190cd50129cedcbcfd219574
parent 0bf57f53

core/api/current.txt

+5 −5
Original line number Diff line number Diff line
@@ -6269,14 +6269,14 @@ package android.app { 
    method public static android.app.PendingIntent getActivities(android.content.Context, int, @NonNull android.content.Intent[], int, @Nullable android.os.Bundle);

    method public static android.app.PendingIntent getActivity(android.content.Context, int, android.content.Intent, int);

    method public static android.app.PendingIntent getActivity(android.content.Context, int, @NonNull android.content.Intent, int, @Nullable android.os.Bundle);

    method public static android.app.PendingIntent getBroadcast(android.content.Context, int, android.content.Intent, int);

    method @Nullable public String getCreatorPackage();

    method public static android.app.PendingIntent getBroadcast(android.content.Context, int, @NonNull android.content.Intent, int);

    method @NonNull public String getCreatorPackage();

    method public int getCreatorUid();

    method @Nullable public android.os.UserHandle getCreatorUserHandle();

    method @NonNull public android.os.UserHandle getCreatorUserHandle();

    method public static android.app.PendingIntent getForegroundService(android.content.Context, int, @NonNull android.content.Intent, int);

    method public android.content.IntentSender getIntentSender();

    method @NonNull public android.content.IntentSender getIntentSender();

    method public static android.app.PendingIntent getService(android.content.Context, int, @NonNull android.content.Intent, int);

    method @Deprecated public String getTargetPackage();

    method @Deprecated @NonNull public String getTargetPackage();

    method public boolean isActivity();

    method public boolean isBroadcast();

    method public boolean isForegroundService();

core/java/android/app/PendingIntent.java

+18 −22
Original line number Diff line number Diff line
@@ -61,6 +61,7 @@ import com.android.internal.os.IResultReceiver; 
import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.util.List;

import java.util.Objects;



/**

 * A description of an Intent and target action to perform with it.  Instances
@@ -464,8 +465,7 @@ public final class PendingIntent implements Parcelable { 
    public static PendingIntent getActivityAsUser(Context context, int requestCode,

            @NonNull Intent intent, int flags, Bundle options, UserHandle user) {

        String packageName = context.getPackageName();

        String resolvedType = intent != null ? intent.resolveTypeIfNeeded(

                context.getContentResolver()) : null;

        String resolvedType = intent.resolveTypeIfNeeded(context.getContentResolver());

        checkFlags(flags, packageName);

        try {

            intent.migrateExtraStreamToClipData(context);
@@ -639,7 +639,7 @@ public final class PendingIntent implements Parcelable { 
     */

    @SuppressWarnings("AndroidFrameworkPendingIntentMutability")

    public static PendingIntent getBroadcast(Context context, int requestCode,

            Intent intent, @Flags int flags) {

            @NonNull Intent intent, @Flags int flags) {

        return getBroadcastAsUser(context, requestCode, intent, flags, context.getUser());

    }
@@ -652,8 +652,7 @@ public final class PendingIntent implements Parcelable { 
    public static PendingIntent getBroadcastAsUser(Context context, int requestCode,

            Intent intent, int flags, UserHandle userHandle) {

        String packageName = context.getPackageName();

        String resolvedType = intent != null ? intent.resolveTypeIfNeeded(

                context.getContentResolver()) : null;

        String resolvedType = intent.resolveTypeIfNeeded(context.getContentResolver());

        checkFlags(flags, packageName);

        try {

            intent.prepareToLeaveProcess(context);
@@ -732,8 +731,7 @@ public final class PendingIntent implements Parcelable { 
    private static PendingIntent buildServicePendingIntent(Context context, int requestCode,

            Intent intent, int flags, int serviceKind) {

        String packageName = context.getPackageName();

        String resolvedType = intent != null ? intent.resolveTypeIfNeeded(

                context.getContentResolver()) : null;

        String resolvedType = intent.resolveTypeIfNeeded(context.getContentResolver());

        checkFlags(flags, packageName);

        try {

            intent.prepareToLeaveProcess(context);
@@ -755,6 +753,7 @@ public final class PendingIntent implements Parcelable { 
     * @return Returns a IntentSender object that wraps the sender of PendingIntent

     *

     */

    @NonNull

    public IntentSender getIntentSender() {

        return new IntentSender(mTarget, mWhitelistToken);

    }
@@ -767,6 +766,7 @@ public final class PendingIntent implements Parcelable { 
        try {

            ActivityManager.getService().cancelIntentSender(mTarget);

        } catch (RemoteException e) {

            throw e.rethrowFromSystemServer();

        }

    }
@@ -1009,6 +1009,7 @@ public final class PendingIntent implements Parcelable { 
     * @deprecated Renamed to {@link #getCreatorPackage()}.

     */

    @Deprecated

    @NonNull

    public String getTargetPackage() {

        return getCreatorPackage();

    }
@@ -1028,10 +1029,9 @@ public final class PendingIntent implements Parcelable { 
     * only use this information to identify who you expect to be interacting with

     * through a {@link #send} call, not who gave you the PendingIntent.</p>

     *

     * @return The package name of the PendingIntent, or null if there is

     * none associated with it.

     * @return The package name of the PendingIntent.

     */

    @Nullable

    @NonNull

    public String getCreatorPackage() {

        return getCachedInfo().getCreatorPackage();

    }
@@ -1143,13 +1143,12 @@ public final class PendingIntent implements Parcelable { 
     * only use this information to identify who you expect to be interacting with

     * through a {@link #send} call, not who gave you the PendingIntent.</p>

     *

     * @return The user handle of the PendingIntent, or null if there is

     * none associated with it.

     * @return The user handle of the PendingIntent

     */

    @Nullable

    @NonNull

    public UserHandle getCreatorUserHandle() {

        int uid = getCachedInfo().getCreatorUid();

        return uid > 0 ? new UserHandle(UserHandle.getUserId(uid)) : null;

        return UserHandle.getUserHandleForUid(uid);

    }



    /**
@@ -1282,7 +1281,7 @@ public final class PendingIntent implements Parcelable { 
        sb.append("PendingIntent{");

        sb.append(Integer.toHexString(System.identityHashCode(this)));

        sb.append(": ");

        sb.append(mTarget != null ? mTarget.asBinder() : null);

        sb.append(mTarget.asBinder());

        sb.append('}');

        return sb.toString();

    }
@@ -1290,9 +1289,7 @@ public final class PendingIntent implements Parcelable { 
    /** @hide */

    public void dumpDebug(ProtoOutputStream proto, long fieldId) {

        final long token = proto.start(fieldId);

        if (mTarget != null) {

        proto.write(PendingIntentProto.TARGET, mTarget.asBinder().toString());

        }

        proto.end(token);

    }
@@ -1309,8 +1306,7 @@ public final class PendingIntent implements Parcelable { 


    }



    public static final @android.annotation.NonNull Parcelable.Creator<PendingIntent> CREATOR

            = new Parcelable.Creator<PendingIntent>() {

    public static final @NonNull Creator<PendingIntent> CREATOR = new Creator<PendingIntent>() {

        public PendingIntent createFromParcel(Parcel in) {

            IBinder target = in.readStrongBinder();

            return target != null
@@ -1364,11 +1360,11 @@ public final class PendingIntent implements Parcelable { 
     * @hide

     */

    public PendingIntent(IIntentSender target) {

        mTarget = target;

        mTarget = Objects.requireNonNull(target);

    }



    /*package*/ PendingIntent(IBinder target, Object cookie) {

        mTarget = IIntentSender.Stub.asInterface(target);

        mTarget = Objects.requireNonNull(IIntentSender.Stub.asInterface(target));

        if (cookie != null) {

            mWhitelistToken = (IBinder)cookie;

        }