Skip to content

Commit ad2932c

Browse files
daymxndaymxn
committed
Rename DataStore to JavaDataStore
1 parent 5619a56 commit ad2932c

File tree

5 files changed

+24
-24
lines changed

5 files changed

+24
-24
lines changed

‎firebase-common/src/main/java/com/google/firebase/datastore/DataStore.kt‎ renamed to ‎firebase-common/src/main/java/com/google/firebase/datastorage/JavaDataStorage.kt‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package com.google.firebase.datastore
17+
package com.google.firebase.datastorage
1818

1919
import android.content.Context
2020
import androidx.datastore.core.DataStore
@@ -43,15 +43,15 @@ import kotlinx.coroutines.runBlocking
4343
*
4444
* Example:
4545
* ```java
46-
* DataStorage heartBeatStorage = new DataStorage(applicationContext, "FirebaseHeartBeat");
46+
* JavaDataStorage heartBeatStorage = new JavaDataStorage(applicationContext, "FirebaseHeartBeat");
4747
* ```
4848
*
4949
* @property context The [Context] that this data will be saved under.
5050
* @property name What the storage file should be named.
5151
*
5252
* @hide
5353
*/
54-
class DataStorage(val context: Context, val name: String) {
54+
class JavaDataStorage(val context: Context, val name: String) {
5555
/**
5656
* Used to ensure that there's only ever one call to [editSync] per thread; as to avoid deadlocks.
5757
*/
@@ -195,7 +195,7 @@ class DataStorage(val context: Context, val name: String) {
195195
if (editLock.get() == true) {
196196
throw IllegalStateException(
197197
"""
198-
Don't call DataStorage.edit() from within an existing edit() callback.
198+
Don't call JavaDataStorage.edit() from within an existing edit() callback.
199199
This causes deadlocks, and is generally indicative of a code smell.
200200
Instead, either pass around the initial `MutablePreferences` instance, or don't do everything in a single callback.
201201
"""
@@ -216,7 +216,7 @@ class DataStorage(val context: Context, val name: String) {
216216
* to the default value.
217217
*
218218
* This is primarily useful when working with an instance of [MutablePreferences]
219-
* - like when working within an [DataStorage.editSync] callback.
219+
* - like when working within an [JavaDataStorage.editSync] callback.
220220
*
221221
* Example:
222222
* ```java

‎firebase-common/src/main/java/com/google/firebase/datastore/package-info.java‎ renamed to ‎firebase-common/src/main/java/com/google/firebase/datastorage/package-info.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
// limitations under the License.
1414

1515
/** @hide */
16-
package com.google.firebase.datastore;
16+
package com.google.firebase.datastorage;

‎firebase-common/src/main/java/com/google/firebase/heartbeatinfo/HeartBeatInfoStorage.java‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020
import androidx.annotation.VisibleForTesting;
2121
import androidx.datastore.preferences.core.*;
2222
import androidx.datastore.preferences.core.Preferences;
23-
import com.google.firebase.datastore.DataStorage;
24-
import com.google.firebase.datastore.DataStoreKt;
23+
import com.google.firebase.datastorage.JavaDataStorage;
24+
import com.google.firebase.datastorage.JavaDataStorageKt;
2525
import java.text.SimpleDateFormat;
2626
import java.time.Instant;
2727
import java.time.LocalDateTime;
@@ -58,17 +58,17 @@ class HeartBeatInfoStorage {
5858
// As soon as you hit the limit of heartbeats. The number of stored heartbeats is halved.
5959
private static final int HEART_BEAT_COUNT_LIMIT = 30;
6060

61-
private final DataStorage firebaseDataStore;
61+
private final JavaDataStorage firebaseDataStore;
6262

6363
public HeartBeatInfoStorage(Context applicationContext, String persistenceKey) {
6464
this.firebaseDataStore =
65-
new DataStorage(applicationContext, HEARTBEAT_PREFERENCES_NAME + persistenceKey);
65+
new JavaDataStorage(applicationContext, HEARTBEAT_PREFERENCES_NAME + persistenceKey);
6666
}
6767

6868
@VisibleForTesting
6969
@RestrictTo(RestrictTo.Scope.TESTS)
70-
HeartBeatInfoStorage(DataStorage dataStorage) {
71-
this.firebaseDataStore = dataStorage;
70+
HeartBeatInfoStorage(JavaDataStorage javaDataStorage) {
71+
this.firebaseDataStore = javaDataStorage;
7272
}
7373

7474
@VisibleForTesting
@@ -146,7 +146,7 @@ private synchronized void updateStoredUserAgent(
146146
MutablePreferences preferences, Preferences.Key<Set<String>> userAgent, String dateString) {
147147
removeStoredDate(preferences, dateString);
148148
Set<String> userAgentDateSet =
149-
new HashSet<>(DataStoreKt.getOrDefault(preferences, userAgent, new HashSet<>()));
149+
new HashSet<>(JavaDataStorageKt.getOrDefault(preferences, userAgent, new HashSet<>()));
150150
userAgentDateSet.add(dateString);
151151
preferences.set(userAgent, userAgentDateSet);
152152
}
@@ -158,7 +158,7 @@ private synchronized void removeStoredDate(MutablePreferences preferences, Strin
158158
return;
159159
}
160160
Set<String> userAgentDateSet =
161-
new HashSet<>(DataStoreKt.getOrDefault(preferences, userAgent, new HashSet<>()));
161+
new HashSet<>(JavaDataStorageKt.getOrDefault(preferences, userAgent, new HashSet<>()));
162162
userAgentDateSet.remove(dateString);
163163
if (userAgentDateSet.isEmpty()) {
164164
preferences.remove(userAgent);
@@ -193,7 +193,7 @@ synchronized void storeHeartBeat(long millis, String userAgentString) {
193193
Preferences.Key<Set<String>> userAgent = PreferencesKeys.stringSetKey(userAgentString);
194194
firebaseDataStore.editSync(
195195
(pref) -> {
196-
String lastDateString = DataStoreKt.getOrDefault(pref, LAST_STORED_DATE, "");
196+
String lastDateString = JavaDataStorageKt.getOrDefault(pref, LAST_STORED_DATE, "");
197197
if (lastDateString.equals(dateString)) {
198198
Preferences.Key<Set<String>> storedUserAgent =
199199
getStoredUserAgentString(pref, dateString);
@@ -208,12 +208,12 @@ synchronized void storeHeartBeat(long millis, String userAgentString) {
208208
return null;
209209
}
210210
}
211-
long heartBeatCount = DataStoreKt.getOrDefault(pref, HEART_BEAT_COUNT_TAG, 0L);
211+
long heartBeatCount = JavaDataStorageKt.getOrDefault(pref, HEART_BEAT_COUNT_TAG, 0L);
212212
if (heartBeatCount + 1 == HEART_BEAT_COUNT_LIMIT) {
213213
heartBeatCount = cleanUpStoredHeartBeats(pref);
214214
}
215215
Set<String> userAgentDateSet =
216-
new HashSet<>(DataStoreKt.getOrDefault(pref, userAgent, new HashSet<>()));
216+
new HashSet<>(JavaDataStorageKt.getOrDefault(pref, userAgent, new HashSet<>()));
217217
userAgentDateSet.add(dateString);
218218
heartBeatCount += 1;
219219

@@ -226,7 +226,7 @@ synchronized void storeHeartBeat(long millis, String userAgentString) {
226226
}
227227

228228
private synchronized long cleanUpStoredHeartBeats(MutablePreferences preferences) {
229-
long heartBeatCount = DataStoreKt.getOrDefault(preferences, HEART_BEAT_COUNT_TAG, 0L);
229+
long heartBeatCount = JavaDataStorageKt.getOrDefault(preferences, HEART_BEAT_COUNT_TAG, 0L);
230230

231231
String lowestDate = null;
232232
String userAgentString = "";

‎firebase-common/src/test/java/com/google/firebase/heartbeatinfo/DefaultHeartBeatControllerTest.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
import androidx.test.core.app.ApplicationProvider;
2929
import androidx.test.ext.junit.runners.AndroidJUnit4;
3030
import com.google.common.collect.ImmutableSet;
31-
import com.google.firebase.datastore.DataStorage;
31+
import com.google.firebase.datastorage.JavaDataStorage;
3232
import com.google.firebase.platforminfo.UserAgentPublisher;
3333
import java.io.ByteArrayOutputStream;
3434
import java.io.IOException;
@@ -107,7 +107,7 @@ public void generateHeartBeat_oneHeartBeat() throws InterruptedException, Timeou
107107
public void firstNewThenOld_synchronizedCorrectly()
108108
throws InterruptedException, TimeoutException {
109109
Context context = ApplicationProvider.getApplicationContext();
110-
DataStorage heartBeatDataStore = new DataStorage(context, "testHeartBeat");
110+
JavaDataStorage heartBeatDataStore = new JavaDataStorage(context, "testHeartBeat");
111111
HeartBeatInfoStorage heartBeatInfoStorage = new HeartBeatInfoStorage(heartBeatDataStore);
112112
DefaultHeartBeatController controller =
113113
new DefaultHeartBeatController(
@@ -128,7 +128,7 @@ public void firstNewThenOld_synchronizedCorrectly()
128128
public void firstOldThenNew_synchronizedCorrectly()
129129
throws InterruptedException, TimeoutException {
130130
Context context = ApplicationProvider.getApplicationContext();
131-
DataStorage heartBeatDataStore = new DataStorage(context, "testHeartBeat");
131+
JavaDataStorage heartBeatDataStore = new JavaDataStorage(context, "testHeartBeat");
132132
HeartBeatInfoStorage heartBeatInfoStorage = new HeartBeatInfoStorage(heartBeatDataStore);
133133
DefaultHeartBeatController controller =
134134
new DefaultHeartBeatController(

‎firebase-common/src/test/java/com/google/firebase/heartbeatinfo/HeartBeatInfoStorageTest.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
import androidx.datastore.preferences.core.PreferencesKeys;
2222
import androidx.test.core.app.ApplicationProvider;
2323
import androidx.test.runner.AndroidJUnit4;
24-
import com.google.firebase.datastore.DataStorage;
24+
import com.google.firebase.datastorage.JavaDataStorage;
2525
import java.util.ArrayList;
2626
import java.util.Collections;
2727
import java.util.HashSet;
@@ -38,8 +38,8 @@ public class HeartBeatInfoStorageTest {
3838
private final Preferences.Key<Long> GLOBAL = PreferencesKeys.longKey("fire-global");
3939
private static final int HEART_BEAT_COUNT_LIMIT = 30;
4040
private static Context applicationContext = ApplicationProvider.getApplicationContext();
41-
private static DataStorage heartBeatDataStore =
42-
new DataStorage(applicationContext, "testHeartBeat");
41+
private static JavaDataStorage heartBeatDataStore =
42+
new JavaDataStorage(applicationContext, "testHeartBeat");
4343
private HeartBeatInfoStorage heartBeatInfoStorage = new HeartBeatInfoStorage(heartBeatDataStore);
4444

4545
@Before

0 commit comments

Comments
 (0)