File: SettingsStringUtil.java

package info (click to toggle)
android-platform-frameworks-base 1%3A10.0.0%2Br36-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 321,788 kB
  • sloc: java: 962,234; cpp: 274,314; xml: 242,770; python: 5,060; sh: 1,432; ansic: 494; makefile: 47; sed: 19
file content (181 lines) | stat: -rw-r--r-- 6,254 bytes parent folder | download | duplicates (3)
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
/*
 * Copyright (C) 2017 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.provider;

import android.content.ComponentName;
import android.content.ContentResolver;
import android.text.TextUtils;

import com.android.internal.util.ArrayUtils;

import java.util.Collection;
import java.util.HashSet;
import java.util.Iterator;
import java.util.function.Function;

/**
 * Utilities for dealing with {@link String} values in {@link Settings}
 *
 * @hide
 */
public class SettingsStringUtil {
    private SettingsStringUtil() {}

    public static final String DELIMITER = ":";

    /**
     * A {@link HashSet} of items, that uses a common convention of setting string
     * serialization/deserialization of separating multiple items with {@link #DELIMITER}
     */
    public static abstract class ColonDelimitedSet<T> extends HashSet<T> {

        public ColonDelimitedSet(String colonSeparatedItems) {
            for (String cn :
                    TextUtils.split(TextUtils.emptyIfNull(colonSeparatedItems), DELIMITER)) {
                add(itemFromString(cn));
            }
        }

        protected abstract T itemFromString(String s);
        protected String itemToString(T item) {
            return String.valueOf(item);
        }

        @Override
        public String toString() {
            StringBuilder sb = new StringBuilder();
            Iterator<T> it = iterator();
            if (it.hasNext()) {
                sb.append(itemToString(it.next()));
                while (it.hasNext()) {
                    sb.append(DELIMITER);
                    sb.append(itemToString(it.next()));
                }
            }
            return sb.toString();
        }


        public static class OfStrings extends ColonDelimitedSet<String> {
            public OfStrings(String colonSeparatedItems) {
                super(colonSeparatedItems);
            }

            @Override
            protected String itemFromString(String s) {
                return s;
            }

            public static String addAll(String delimitedElements, Collection<String> elements) {
                final ColonDelimitedSet<String> set
                        = new ColonDelimitedSet.OfStrings(delimitedElements);
                return set.addAll(elements) ? set.toString() : delimitedElements;
            }

            public static String add(String delimitedElements, String element) {
                final ColonDelimitedSet<String> set
                        = new ColonDelimitedSet.OfStrings(delimitedElements);
                if (set.contains(element)) {
                    return delimitedElements;
                }
                set.add(element);
                return set.toString();
            }

            public static String remove(String delimitedElements, String element) {
                final ColonDelimitedSet<String> set
                        = new ColonDelimitedSet.OfStrings(delimitedElements);
                if (!set.contains(element)) {
                    return delimitedElements;
                }
                set.remove(element);
                return set.toString();
            }

            public static boolean contains(String delimitedElements, String element) {
                final String[] elements = TextUtils.split(delimitedElements, DELIMITER);
                return ArrayUtils.indexOf(elements, element) != -1;
            }
        }
    }

    public static class ComponentNameSet extends ColonDelimitedSet<ComponentName> {
        public ComponentNameSet(String colonSeparatedPackageNames) {
            super(colonSeparatedPackageNames);
        }

        @Override
        protected ComponentName itemFromString(String s) {
            return ComponentName.unflattenFromString(s);
        }

        @Override
        protected String itemToString(ComponentName item) {
            return item.flattenToString();
        }

        public static String add(String delimitedElements, ComponentName element) {
            final ComponentNameSet set = new ComponentNameSet(delimitedElements);
            if (set.contains(element)) {
                return delimitedElements;
            }
            set.add(element);
            return set.toString();
        }

        public static String remove(String delimitedElements, ComponentName element) {
            final ComponentNameSet set = new ComponentNameSet(delimitedElements);
            if (!set.contains(element)) {
                return delimitedElements;
            }
            set.remove(element);
            return set.toString();
        }

        public static boolean contains(String delimitedElements, ComponentName element) {
            return ColonDelimitedSet.OfStrings.contains(
                    delimitedElements, element.flattenToString());
        }
    }

    public static class SettingStringHelper {
        private final ContentResolver mContentResolver;
        private final String mSettingName;
        private final int mUserId;

        public SettingStringHelper(ContentResolver contentResolver, String name, int userId) {
            mContentResolver = contentResolver;
            mUserId = userId;
            mSettingName = name;
        }

        public String read() {
            return Settings.Secure.getStringForUser(
                    mContentResolver, mSettingName, mUserId);
        }

        public boolean write(String value) {
            return Settings.Secure.putStringForUser(
                    mContentResolver, mSettingName, value, mUserId);
        }

        public boolean modify(Function<String, String> change) {
            return write(change.apply(read()));
        }
    }
}