File: TimeCapabilities.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 (186 lines) | stat: -rw-r--r-- 6,901 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
179
180
181
182
183
184
185
186
/*
 * Copyright (C) 2021 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.time;

import android.annotation.NonNull;
import android.app.time.Capabilities.CapabilityState;
import android.os.Parcel;
import android.os.Parcelable;
import android.os.UserHandle;

import java.util.Objects;

/**
 * Time-relate capabilities for a user.
 *
 * <p>For configuration settings capabilities, the associated settings value can be found via
 * {@link TimeManager#getTimeCapabilitiesAndConfig()} and may be changed using {@link
 * TimeManager#updateTimeConfiguration(TimeConfiguration)} (if the user's capabilities
 * allow).
 *
 * @hide
 */
public final class TimeCapabilities implements Parcelable {

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

                public TimeCapabilities[] newArray(int size) {
                    return new TimeCapabilities[size];
                }
            };


    /**
     * The user the capabilities are for. This is used for object equality and debugging but there
     * is no accessor.
     */
    @NonNull
    private final UserHandle mUserHandle;
    private final @CapabilityState int mConfigureAutoTimeDetectionEnabledCapability;
    private final @CapabilityState int mSuggestTimeManuallyCapability;

    private TimeCapabilities(@NonNull Builder builder) {
        this.mUserHandle = Objects.requireNonNull(builder.mUserHandle);
        this.mConfigureAutoTimeDetectionEnabledCapability =
                builder.mConfigureAutoDetectionEnabledCapability;
        this.mSuggestTimeManuallyCapability =
                builder.mSuggestTimeManuallyCapability;
    }

    @NonNull
    private static TimeCapabilities createFromParcel(Parcel in) {
        UserHandle userHandle = UserHandle.readFromParcel(in);
        return new TimeCapabilities.Builder(userHandle)
                .setConfigureAutoTimeDetectionEnabledCapability(in.readInt())
                .setSuggestTimeManuallyCapability(in.readInt())
                .build();
    }

    @Override
    public void writeToParcel(@NonNull Parcel dest, int flags) {
        UserHandle.writeToParcel(mUserHandle, dest);
        dest.writeInt(mConfigureAutoTimeDetectionEnabledCapability);
        dest.writeInt(mSuggestTimeManuallyCapability);
    }

    /**
     * Returns the capability state associated with the user's ability to modify the automatic time
     * detection setting.
     */
    @CapabilityState
    public int getConfigureAutoTimeDetectionEnabledCapability() {
        return mConfigureAutoTimeDetectionEnabledCapability;
    }

    /**
     * Returns the capability state associated with the user's ability to manually set time on a
     * device.
     */
    @CapabilityState
    public int getSuggestTimeManuallyCapability() {
        return mSuggestTimeManuallyCapability;
    }

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

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        TimeCapabilities that = (TimeCapabilities) o;
        return mConfigureAutoTimeDetectionEnabledCapability
                == that.mConfigureAutoTimeDetectionEnabledCapability
                && mSuggestTimeManuallyCapability == that.mSuggestTimeManuallyCapability
                && mUserHandle.equals(that.mUserHandle);
    }

    @Override
    public int hashCode() {
        return Objects.hash(mUserHandle, mConfigureAutoTimeDetectionEnabledCapability,
                mSuggestTimeManuallyCapability);
    }

    @Override
    public String toString() {
        return "TimeCapabilities{"
                + "mUserHandle=" + mUserHandle
                + ", mConfigureAutoTimeDetectionEnabledCapability="
                + mConfigureAutoTimeDetectionEnabledCapability
                + ", mSuggestTimeManuallyCapability=" + mSuggestTimeManuallyCapability
                + '}';
    }

    /**
     * A builder of {@link TimeCapabilities} objects.
     *
     * @hide
     */
    public static class Builder {
        @NonNull private final UserHandle mUserHandle;
        private @CapabilityState int mConfigureAutoDetectionEnabledCapability;
        private @CapabilityState int mSuggestTimeManuallyCapability;

        public Builder(@NonNull TimeCapabilities timeCapabilities) {
            Objects.requireNonNull(timeCapabilities);
            this.mUserHandle = timeCapabilities.mUserHandle;
            this.mConfigureAutoDetectionEnabledCapability =
                    timeCapabilities.mConfigureAutoTimeDetectionEnabledCapability;
            this.mSuggestTimeManuallyCapability =
                    timeCapabilities.mSuggestTimeManuallyCapability;
        }

        public Builder(@NonNull UserHandle userHandle) {
            this.mUserHandle = Objects.requireNonNull(userHandle);
        }

        /** Sets the state for automatic time detection config. */
        public Builder setConfigureAutoTimeDetectionEnabledCapability(
                @CapabilityState int setConfigureAutoTimeDetectionEnabledCapability) {
            this.mConfigureAutoDetectionEnabledCapability =
                    setConfigureAutoTimeDetectionEnabledCapability;
            return this;
        }

        /** Sets the state for manual time change. */
        public Builder setSuggestTimeManuallyCapability(
                @CapabilityState int suggestTimeManuallyCapability) {
            this.mSuggestTimeManuallyCapability = suggestTimeManuallyCapability;
            return this;
        }

        /** Returns the {@link TimeCapabilities}. */
        public TimeCapabilities build() {
            verifyCapabilitySet(mConfigureAutoDetectionEnabledCapability,
                    "configureAutoDetectionEnabledCapability");
            verifyCapabilitySet(mSuggestTimeManuallyCapability, "suggestTimeManuallyCapability");
            return new TimeCapabilities(this);
        }

        private void verifyCapabilitySet(int value, String name) {
            if (value == 0) {
                throw new IllegalStateException(name + " was not set");
            }
        }
    }
}