File: SystemDataTransferRequest.java

package info (click to toggle)
android-platform-frameworks-base 1%3A14~beta1-3
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 326,092 kB
  • sloc: java: 2,032,373; xml: 343,016; cpp: 304,181; python: 3,683; ansic: 2,090; sh: 1,871; makefile: 117; sed: 19
file content (157 lines) | stat: -rw-r--r-- 5,336 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
/*
 * Copyright (C) 2022 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package android.companion;

import android.annotation.NonNull;
import android.annotation.Nullable;
import android.os.Parcel;
import android.os.Parcelable;
import android.provider.OneTimeUseBuilder;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

/**
 * A request for users to allow the companion app to transfer system data to the companion devices.
 *
 * @hide
 */
public final class SystemDataTransferRequest implements Parcelable {

    private final int mAssociationId;
    private final boolean mPermissionSyncAllPackages;
    private final List<String> mPermissionSyncPackages;

    /**
     * @hide
     */
    public SystemDataTransferRequest(int associationId, boolean syncAllPackages,
            @Nullable List<String> permissionSyncPackages) {
        mAssociationId = associationId;
        mPermissionSyncAllPackages = syncAllPackages;
        mPermissionSyncPackages = permissionSyncPackages;
    }

    public int getAssociationId() {
        return mAssociationId;
    }

    @NonNull
    public boolean isPermissionSyncAllPackages() {
        return mPermissionSyncAllPackages;
    }

    @NonNull
    public List<String> getPermissionSyncPackages() {
        return mPermissionSyncPackages;
    }

    /**
     * A builder for {@link SystemDataTransferRequest}.
     *
     * <p>You have to call one of the below methods to create a valid request</p>
     * <br>1. {@link #setPermissionSyncAllPackages()}
     * <br>2. {@link #setPermissionSyncPackages(List)}
     */
    public static final class Builder extends OneTimeUseBuilder<SystemDataTransferRequest> {

        private final int mAssociationId;
        private boolean mPermissionSyncAllPackages;
        private List<String> mPermissionSyncPackages = new ArrayList<>();

        public Builder(int associationId) {
            mAssociationId = associationId;
        }

        /**
         * Call to sync permissions for all the packages. You can optionally call
         * {@link #setPermissionSyncPackages(List)} to specify the packages to sync permissions.
         *
         * <p>The system will only sync permissions that are explicitly granted by the user.</p>
         *
         * <p>If a permission is granted or revoked by the system or a policy, even if the user has
         * explicitly granted or revoked the permission earlier, the permission will be ignored.</p>
         *
         * <p>If a system or policy granted or revoked permission is granted or revoked by the user
         * later, the permission will be ignored.</p>
         *
         * @see #setPermissionSyncPackages(List)
         *
         * @return the builder
         */
        @NonNull
        public Builder setPermissionSyncAllPackages() {
            mPermissionSyncAllPackages = true;
            return this;
        }

        /**
         * Set a list of packages to sync permissions. You can optionally call
         * {@link #setPermissionSyncAllPackages()} to sync permissions for all the packages.
         *
         * @see #setPermissionSyncAllPackages()
         *
         * @param permissionSyncPackages packages to sync permissions
         * @return builder
         */
        @NonNull
        public Builder setPermissionSyncPackages(@NonNull List<String> permissionSyncPackages) {
            mPermissionSyncPackages = permissionSyncPackages;
            return this;
        }

        @Override
        @NonNull
        public SystemDataTransferRequest build() {
            return new SystemDataTransferRequest(mAssociationId, mPermissionSyncAllPackages,
                    mPermissionSyncPackages);
        }
    }

    SystemDataTransferRequest(Parcel in) {
        mAssociationId = in.readInt();
        mPermissionSyncAllPackages = in.readBoolean();
        mPermissionSyncPackages = Arrays.asList(in.createString8Array());
    }

    @Override
    public void writeToParcel(@NonNull Parcel dest, int flags) {
        dest.writeInt(mAssociationId);
        dest.writeBoolean(mPermissionSyncAllPackages);
        dest.writeString8Array(mPermissionSyncPackages.toArray(new String[0]));
    }

    @Override
    public int describeContents() {
        return 0;
    }

    @NonNull
    public static final Creator<SystemDataTransferRequest> CREATOR =
            new Creator<SystemDataTransferRequest>() {
                @Override
                public SystemDataTransferRequest createFromParcel(Parcel in) {
                    return new SystemDataTransferRequest(in);
                }

                @Override
                public SystemDataTransferRequest[] newArray(int size) {
                    return new SystemDataTransferRequest[size];
                }
            };
}