aboutsummaryrefslogtreecommitdiff
path: root/common/src/com/android/tv/common/dev/DeveloperPreference.java
blob: b1c401b0c802d3034c72caadec116c7cd576bfe7 (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
123
124
125
126
127
128
129
130
131
132
/*
 * Copyright (C) 2019 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 com.android.tv.common.dev;

import android.content.Context;
import android.content.SharedPreferences;
import android.support.annotation.Nullable;
import android.support.annotation.VisibleForTesting;

/** Preferences available to developers */
public abstract class DeveloperPreference<T> {

    private static final String PREFERENCE_FILE_NAME =
            "com.android.tv.common.dev.DeveloperPreference";

    /**
     * Create a boolean developer preference.
     *
     * @param key the developer setting key.
     * @param defaultValue the value to return if the setting is undefined or empty.
     */
    public static DeveloperPreference<Boolean> create(String key, boolean defaultValue) {
        return new DeveloperBooleanPreference(key, defaultValue);
    }

    @VisibleForTesting
    static final SharedPreferences getPreferences(Context context) {
        return context.getSharedPreferences(PREFERENCE_FILE_NAME, Context.MODE_PRIVATE);
    }

    /**
     * Create a int developer preference.
     *
     * @param key the developer setting key.
     * @param defaultValue the value to return if the setting is undefined or empty.
     */
    public static DeveloperPreference<Integer> create(String key, int defaultValue) {
        return new DeveloperIntegerPreference(key, defaultValue);
    }

    final String mKey;
    final T mDefaultValue;
    private T mValue;

    private DeveloperPreference(String key, T defaultValue) {
        mKey = key;
        mValue = null;
        mDefaultValue = defaultValue;
    }

    /** Set the value. */
    public final void set(Context context, T value) {
        mValue = value;
        storeValue(context, value);
    }

    protected abstract void storeValue(Context context, T value);

    /** Get the current value, or the default if the value is not set. */
    public final T get(Context context) {
        mValue = getStoredValue(context);
        return mValue;
    }

    /** Get the current value, or the default if the value is not set or context is null. */
    public final T getDefaultIfContextNull(@Nullable Context context) {
        return context == null ? mDefaultValue : getStoredValue(context);
    }

    protected abstract T getStoredValue(Context context);

    /**
     * Clears the current value.
     *
     * <p>Future calls to {@link #get(Context)} will return the default value.
     */
    public final void clear(Context context) {
        getPreferences(context).edit().remove(mKey);
    }

    @Override
    public final String toString() {
        return "[" + mKey + "]=" + mValue + " Default value : " + mDefaultValue;
    }

    private static final class DeveloperBooleanPreference extends DeveloperPreference<Boolean> {

        private DeveloperBooleanPreference(String key, Boolean defaultValue) {
            super(key, defaultValue);
        }

        @Override
        public void storeValue(Context context, Boolean value) {
            getPreferences(context).edit().putBoolean(mKey, value).apply();
        }

        @Override
        public Boolean getStoredValue(Context context) {
            return getPreferences(context).getBoolean(mKey, mDefaultValue);
        }
    }

    private static final class DeveloperIntegerPreference extends DeveloperPreference<Integer> {

        private DeveloperIntegerPreference(String key, Integer defaultValue) {
            super(key, defaultValue);
        }

        @Override
        protected void storeValue(Context context, Integer value) {
            getPreferences(context).edit().putInt(mKey, value).apply();
        }

        @Override
        protected Integer getStoredValue(Context context) {
            return getPreferences(context).getInt(mKey, mDefaultValue);
        }
    }
}