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

Commit 3632fde8 authored by Youkichi Hosoi's avatar Youkichi Hosoi
Browse files

Expose StorageVolume.isStub() as @SystemApi API 

StorageVolume.isStub() indicates whether the volume is a StubVolume,
i.e. whether it is a volume managed from outside Android (e.g. from
Chrome OS).
It needs to be exposed as a @SystemApi API because the MediaProvider
module will use it to decide whether default folders like Music, Movies,
Pictures, etc. should be automatically created inside a volume; when the
volume is a StubVolume, such automatic creation should be avoided.

Bug: 206019156
Test: m
Test: atest MtpTests
Test: atest StorageManagerTest#testGetPrimaryVolume

Change-Id: I9a9bd170408c5d92c94eac33cdab9aea394b324e
parent a7c80fad

core/api/system-current.txt

+1 −0
Original line number Diff line number Diff line
@@ -9112,6 +9112,7 @@ package android.os.storage { 














  public final class StorageVolume implements android.os.Parcelable {















    method @NonNull public String getId();













    method public boolean isStub();















  }





























}

























core/java/android/os/storage/StorageVolume.java



+20
−3




























Original line number
Diff line number
Diff line








@@ -99,6 +99,7 @@ public final class StorageVolume implements Parcelable {













    @UnsupportedAppUsage















    private final boolean mRemovable;















    private final boolean mEmulated;













    private final boolean mStub;















    private final boolean mAllowMassStorage;















    private final long mMaxFileSize;















    private final UserHandle mOwner;










@@ -137,8 +138,9 @@ public final class StorageVolume implements Parcelable {





























    /** {@hide} */















    public StorageVolume(String id, File path, File internalPath, String description,













            boolean primary, boolean removable, boolean emulated, boolean allowMassStorage,













            long maxFileSize, UserHandle owner, UUID uuid, String fsUuid, String state) {













            boolean primary, boolean removable, boolean emulated, boolean stub,













            boolean allowMassStorage, long maxFileSize, UserHandle owner, UUID uuid, String fsUuid,













            String state) {















        mId = Preconditions.checkNotNull(id);















        mPath = Preconditions.checkNotNull(path);















        mInternalPath = Preconditions.checkNotNull(internalPath);









@@ -146,6 +148,7 @@ public final class StorageVolume implements Parcelable {













        mPrimary = primary;















        mRemovable = removable;















        mEmulated = emulated;













        mStub = stub;















        mAllowMassStorage = allowMassStorage;















        mMaxFileSize = maxFileSize;















        mOwner = Preconditions.checkNotNull(owner);









@@ -162,6 +165,7 @@ public final class StorageVolume implements Parcelable {













        mPrimary = in.readInt() != 0;















        mRemovable = in.readInt() != 0;















        mEmulated = in.readInt() != 0;













        mStub = in.readInt() != 0;















        mAllowMassStorage = in.readInt() != 0;















        mMaxFileSize = in.readLong();















        mOwner = in.readParcelable(null);










@@ -264,12 +268,22 @@ public final class StorageVolume implements Parcelable {













    /**















     * Returns true if the volume is emulated.















     *













     * @return is removable













     * @return is emulated















     */















    public boolean isEmulated() {















        return mEmulated;















    }





























    /**













     * Returns true if the volume is a stub volume (a volume managed from outside Android).













     *













     * @hide













     */













    @SystemApi













    public boolean isStub() {













        return mStub;













    }





























    /**















     * Returns true if this volume can be shared via USB mass storage.















     *










@@ -506,6 +520,7 @@ public final class StorageVolume implements Parcelable {













        pw.printPair("mPrimary", mPrimary);















        pw.printPair("mRemovable", mRemovable);















        pw.printPair("mEmulated", mEmulated);













        pw.printPair("mStub", mStub);















        pw.printPair("mAllowMassStorage", mAllowMassStorage);















        pw.printPair("mMaxFileSize", mMaxFileSize);















        pw.printPair("mOwner", mOwner);










@@ -540,6 +555,7 @@ public final class StorageVolume implements Parcelable {













        parcel.writeInt(mPrimary ? 1 : 0);















        parcel.writeInt(mRemovable ? 1 : 0);















        parcel.writeInt(mEmulated ? 1 : 0);













        parcel.writeInt(mStub ? 1 : 0);















        parcel.writeInt(mAllowMassStorage ? 1 : 0);















        parcel.writeLong(mMaxFileSize);















        parcel.writeParcelable(mOwner, flags);










@@ -621,6 +637,7 @@ public final class StorageVolume implements Parcelable {













                    mPrimary,















                    mRemovable,















                    mEmulated,













                    /* stub= */ false,















                    /* allowMassStorage= */ false,















                    /* maxFileSize= */ 0,















                    mOwner,

































core/java/android/os/storage/VolumeInfo.java



+3
−2




























Original line number
Diff line number
Diff line








@@ -388,6 +388,7 @@ public class VolumeInfo implements Parcelable {





























        final boolean removable;















        final boolean emulated;













        final boolean stub = type == TYPE_STUB;















        final boolean allowMassStorage = false;















        final String envState = reportUnmounted















                ? Environment.MEDIA_UNMOUNTED : getEnvironmentForState(state);










@@ -443,8 +444,8 @@ public class VolumeInfo implements Parcelable {













        }































        return new StorageVolume(id, userPath, internalPath, description, isPrimary(), removable,













                emulated, allowMassStorage, maxFileSize, new UserHandle(userId),













                uuid, derivedFsUuid, envState);













                emulated, stub, allowMassStorage, maxFileSize, new UserHandle(userId), uuid,













                derivedFsUuid, envState);















    }































    @UnsupportedAppUsage

































core/java/android/os/storage/VolumeRecord.java



+3
−1




























Original line number
Diff line number
Diff line








@@ -105,6 +105,7 @@ public class VolumeRecord implements Parcelable {













        final boolean primary = false;















        final boolean removable = true;















        final boolean emulated = false;













        final boolean stub = false;















        final boolean allowMassStorage = false;















        final long maxFileSize = 0;















        final UserHandle user = new UserHandle(UserHandle.USER_NULL);









@@ -116,7 +117,8 @@ public class VolumeRecord implements Parcelable {













        }































        return new StorageVolume(id, userPath, internalPath, description, primary, removable,













                emulated, allowMassStorage, maxFileSize, user, null /* uuid */, fsUuid, envState);













                emulated, stub, allowMassStorage, maxFileSize, user, null /* uuid */, fsUuid,













                envState);















    }































    public void dump(IndentingPrintWriter pw) {

































media/tests/MtpTests/src/android/mtp/MtpDatabaseTest.java



+1
−1




























Original line number
Diff line number
Diff line








@@ -132,7 +132,7 @@ public class MtpDatabaseTest {





























        StorageVolume mainStorage = new StorageVolume(MAIN_STORAGE_ID_STR,















                mMainStorageDir, mMainStorageDir, "Primary Storage",













                true, false, true, false, -1, UserHandle.CURRENT, null /* uuid */, "", "");













                true, false, true, false, false, -1, UserHandle.CURRENT, null /* uuid */, "", "");































        final StorageVolume primary = mainStorage;