aboutsummaryrefslogtreecommitdiff
path: root/car-lib/src/android/car/settings/SpeedBumpConfiguration.java
blob: 39a1eabdf44ff4eafd2329a9f952ee479ff6e684 (plain)
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
/*
 * Copyright (C) 2018 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.car.settings;

import android.os.Parcel;
import android.os.Parcelable;

import java.util.Objects;

/**
 * A configuration struct that holds information for tweaking SpeedBump settings.
 *
 * @see androidx.car.moderator.SpeedBumpView
 */
public final class SpeedBumpConfiguration implements Parcelable {
    private final double mAcquiredPermitsPerSecond;
    private final double mMaxPermitPool;
    private final long mPermitFillDelay;

    public SpeedBumpConfiguration(double permitsPerSecond, double maxPermitPool,
            long permitFillDelay) {
        mAcquiredPermitsPerSecond = permitsPerSecond;
        mMaxPermitPool = maxPermitPool;
        mPermitFillDelay = permitFillDelay;
    }

    /**
     * Returns the number of permitted actions that are acquired each second that the user has not
     * interacted with the {@code SpeedBumpView}.
     */
    public double getAcquiredPermitsPerSecond() {
        return mAcquiredPermitsPerSecond;
    }

    /**
     * Returns the maximum number of permits that can be acquired when the user is idling.
     */
    public double getMaxPermitPool() {
        return mMaxPermitPool;
    }

    /**
     * Returns the delay time before when the permit pool has been depleted and when it begins to
     * refill.
     */
    public long getPermitFillDelay() {
        return mPermitFillDelay;
    }

    @Override
    public String toString() {
        return String.format(
                "[acquired_permits_per_second: %f, max_permit_pool: %f, permit_fill_delay: %d]",
                mAcquiredPermitsPerSecond,
                mMaxPermitPool,
                mPermitFillDelay);
    }

    @Override
    public boolean equals(Object object) {
        if (object == this) {
            return true;
        }

        if (!(object instanceof SpeedBumpConfiguration)) {
            return false;
        }

        SpeedBumpConfiguration other = (SpeedBumpConfiguration) object;
        return mAcquiredPermitsPerSecond == other.getAcquiredPermitsPerSecond()
                && mMaxPermitPool == other.getMaxPermitPool()
                && mPermitFillDelay == other.getPermitFillDelay();
    }

    @Override
    public int hashCode() {
        return Objects.hash(mAcquiredPermitsPerSecond, mMaxPermitPool, mPermitFillDelay);
    }

    @Override
    public void writeToParcel(Parcel desk, int flags) {
        desk.writeDouble(mAcquiredPermitsPerSecond);
        desk.writeDouble(mMaxPermitPool);
        desk.writeLong(mPermitFillDelay);
    }

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

    private SpeedBumpConfiguration(Parcel in) {
        mAcquiredPermitsPerSecond = in.readDouble();
        mMaxPermitPool = in.readDouble();
        mPermitFillDelay = in.readLong();
    }

    public static final Parcelable.Creator<SpeedBumpConfiguration> CREATOR =
            new Parcelable.Creator<SpeedBumpConfiguration>() {
        public SpeedBumpConfiguration createFromParcel(Parcel in) {
            return new SpeedBumpConfiguration(in);
        }

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