Preferences.java
/*
* Copyright 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 androidx.work.impl.utils;
import android.content.Context;
import android.content.SharedPreferences;
import androidx.annotation.NonNull;
import androidx.annotation.RestrictTo;
import androidx.annotation.VisibleForTesting;
import androidx.lifecycle.LiveData;
import androidx.lifecycle.MutableLiveData;
/**
* Preferences for WorkManager.
*
* TODO: Migrate all preferences, including IdGenerator, to this file.
*
* @hide
*/
@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
public class Preferences {
private static final String PREFERENCES_FILE_NAME = "androidx.work.util.preferences";
private static final String KEY_LAST_CANCEL_ALL_TIME_MS = "last_cancel_all_time_ms";
private static final String KEY_RESCHEDULE_NEEDED = "reschedule_needed";
private Context mContext;
private SharedPreferences mSharedPreferences;
public Preferences(@NonNull Context context) {
mContext = context;
}
@VisibleForTesting
public Preferences(@NonNull SharedPreferences preferences) {
mSharedPreferences = preferences;
}
/**
* @return The last time (in milliseconds) a {@code cancelAll} method was called
*/
public long getLastCancelAllTimeMillis() {
return getSharedPreferences().getLong(KEY_LAST_CANCEL_ALL_TIME_MS, 0L);
}
/**
* @return A {@link LiveData} of the last time (in milliseconds) a {@code cancelAll} method was
* called
*/
public LiveData<Long> getLastCancelAllTimeMillisLiveData() {
return new LastCancelAllLiveData(getSharedPreferences());
}
/**
* Sets the last time a {@code cancelAll} method was called
*
* @param timeMillis The time a {@code cancelAll} method was called (in milliseconds)
*/
public void setLastCancelAllTimeMillis(long timeMillis) {
getSharedPreferences().edit().putLong(KEY_LAST_CANCEL_ALL_TIME_MS, timeMillis).apply();
}
/**
* @return {@code true} When we should reschedule workers.
*/
public boolean needsReschedule() {
// This preference is being set by a Room Migration.
// TODO Remove this before WorkManager 1.0 beta.
return getSharedPreferences().getBoolean(KEY_RESCHEDULE_NEEDED, false);
}
/**
* Updates the key which indicates that we have rescheduled jobs.
*/
public void setNeedsReschedule(boolean needsReschedule) {
getSharedPreferences().edit().putBoolean(KEY_RESCHEDULE_NEEDED, needsReschedule).apply();
}
private SharedPreferences getSharedPreferences() {
synchronized (Preferences.class) {
if (mSharedPreferences == null) {
mSharedPreferences = mContext.getSharedPreferences(
PREFERENCES_FILE_NAME,
Context.MODE_PRIVATE);
}
return mSharedPreferences;
}
}
/**
* A {@link LiveData} that responds to changes in
* {@link SharedPreferences} for the {@code lastCancelAllTime} value.
*/
private static class LastCancelAllLiveData extends MutableLiveData<Long>
implements SharedPreferences.OnSharedPreferenceChangeListener {
private SharedPreferences mSharedPreferences;
private long mLastCancelAllTimeMillis;
LastCancelAllLiveData(SharedPreferences sharedPreferences) {
mSharedPreferences = sharedPreferences;
mLastCancelAllTimeMillis = mSharedPreferences.getLong(KEY_LAST_CANCEL_ALL_TIME_MS, 0L);
postValue(mLastCancelAllTimeMillis);
}
@Override
public void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key) {
if (KEY_LAST_CANCEL_ALL_TIME_MS.equals(key)) {
long lastCancelAllTimeMillis = sharedPreferences.getLong(key, 0L);
if (mLastCancelAllTimeMillis != lastCancelAllTimeMillis) {
mLastCancelAllTimeMillis = lastCancelAllTimeMillis;
setValue(mLastCancelAllTimeMillis);
}
}
}
@Override
protected void onActive() {
super.onActive();
mSharedPreferences.registerOnSharedPreferenceChangeListener(this);
}
@Override
protected void onInactive() {
super.onInactive();
mSharedPreferences.unregisterOnSharedPreferenceChangeListener(this);
}
}
}