File: AmbientContextEventRequest.java

package info (click to toggle)
android-platform-frameworks-base 1%3A14~beta1-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 326,096 kB
  • sloc: java: 2,032,373; xml: 343,016; cpp: 304,183; python: 3,683; ansic: 2,090; sh: 1,871; makefile: 120; sed: 19
file content (178 lines) | stat: -rw-r--r-- 5,844 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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
/*
 * 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.app.ambientcontext;

import android.annotation.NonNull;
import android.annotation.SystemApi;
import android.os.Parcel;
import android.os.Parcelable;
import android.os.PersistableBundle;
import android.util.ArraySet;

import com.android.internal.util.AnnotationValidations;
import com.android.internal.util.Preconditions;

import java.util.HashSet;
import java.util.Set;

/**
 * Represents the request for ambient event detection.
 *
 * @hide
 */
@SystemApi
public final class AmbientContextEventRequest implements Parcelable {
    @NonNull private final Set<Integer> mEventTypes;
    @NonNull private final PersistableBundle mOptions;

    private AmbientContextEventRequest(
            @NonNull Set<Integer> eventTypes,
            @NonNull PersistableBundle options) {
        this.mEventTypes = eventTypes;
        AnnotationValidations.validate(NonNull.class, null, mEventTypes);
        Preconditions.checkArgument(!eventTypes.isEmpty(), "eventTypes cannot be empty");
        for (int eventType : eventTypes) {
            AnnotationValidations.validate(AmbientContextEvent.EventCode.class, null, eventType);
        }
        this.mOptions = options;
        AnnotationValidations.validate(NonNull.class, null, mOptions);
    }

    /**
     * The event types to detect.
     */
    public @NonNull Set<Integer> getEventTypes() {
        return mEventTypes;
    }

    /**
     * Optional detection options.
     */
    public @NonNull PersistableBundle getOptions() {
        return mOptions;
    }

    @Override
    public String toString() {
        return "AmbientContextEventRequest { " + "eventTypes = " + mEventTypes + ", "
                + "options = " + mOptions + " }";
    }

    @Override
    public void writeToParcel(@NonNull Parcel dest, int flags) {
        dest.writeArraySet(new ArraySet<>(mEventTypes));
        dest.writeTypedObject(mOptions, flags);
    }

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

    /** @hide */
    @SuppressWarnings({"unchecked", "RedundantCast"})
    private AmbientContextEventRequest(@NonNull Parcel in) {
        Set<Integer> eventTypes = (Set<Integer>) in.readArraySet(Integer.class.getClassLoader());
        PersistableBundle options = (PersistableBundle) in.readTypedObject(
                PersistableBundle.CREATOR);

        this.mEventTypes = eventTypes;
        AnnotationValidations.validate(
                NonNull.class, null, mEventTypes);
        Preconditions.checkArgument(!eventTypes.isEmpty(), "eventTypes cannot be empty");
        for (int eventType : eventTypes) {
            AnnotationValidations.validate(AmbientContextEvent.EventCode.class, null, eventType);
        }
        this.mOptions = options;
        AnnotationValidations.validate(
                NonNull.class, null, mOptions);
    }

    public static final @NonNull Parcelable.Creator<AmbientContextEventRequest> CREATOR =
            new Parcelable.Creator<AmbientContextEventRequest>() {
        @Override
        public AmbientContextEventRequest[] newArray(int size) {
            return new AmbientContextEventRequest[size];
        }

        @Override
        public AmbientContextEventRequest createFromParcel(@NonNull Parcel in) {
            return new AmbientContextEventRequest(in);
        }
    };

    /**
     * A builder for {@link AmbientContextEventRequest}
     */
    @SuppressWarnings("WeakerAccess")
    public static final class Builder {
        private @NonNull Set<Integer> mEventTypes;
        private @NonNull PersistableBundle mOptions;

        private long mBuilderFieldsSet = 0L;

        public Builder() {
        }

        /**
         * Add an event type to detect.
         */
        public @NonNull Builder addEventType(@AmbientContextEvent.EventCode int value) {
            checkNotUsed();
            if (mEventTypes == null) {
                mBuilderFieldsSet |= 0x1;
                mEventTypes = new HashSet<>();
            }
            mEventTypes.add(value);
            return this;
        }

        /**
         * Optional detection options.
         */
        public @NonNull Builder setOptions(@NonNull PersistableBundle value) {
            checkNotUsed();
            mBuilderFieldsSet |= 0x2;
            mOptions = value;
            return this;
        }

        /** Builds the instance. This builder should not be touched after calling this! */
        public @NonNull AmbientContextEventRequest build() {
            checkNotUsed();
            mBuilderFieldsSet |= 0x4; // Mark builder used

            if ((mBuilderFieldsSet & 0x1) == 0) {
                mEventTypes = new HashSet<>();
            }
            if ((mBuilderFieldsSet & 0x2) == 0) {
                mOptions = new PersistableBundle();
            }
            AmbientContextEventRequest o = new AmbientContextEventRequest(
                    mEventTypes,
                    mOptions);
            return o;
        }

        private void checkNotUsed() {
            if ((mBuilderFieldsSet & 0x4) != 0) {
                throw new IllegalStateException(
                        "This Builder should not be reused. Use a new Builder instance instead");
            }
        }
    }
}