pranavpandey/dynamic-preferences

Manage shared preferences on Android.

Dynamic Preferences

A library to manage shared preferences on Android 4.0 (API 14) and above.

It uses AndroidX so, first migrate your project to AndroidX.
Since v2.1.0, it is dependent on Java 8 due to the dependency on Dynamic Utils.
Since v2.3.1, it is targeting Java 17 to provide maximum compatibility.
Since v2.4.0, the minimum SDK is Android 4.4 (API 19) to comply with the latest policies.

---

Contents

• Installation
• Usage
  • Initialize
  • Save
  • Load
  • Delete
  • Dependency
• License

---

Installation

It can be installed by adding the following dependency to your build.gradle file:

dependencies {
    // For AndroidX enabled projects.
    implementation 'com.pranavpandey.android:dynamic-preferences:2.4.0'
}

---

Usage

It provides various methods to save, load and delete keys and preferences. Please read below about the various supported operations.

For a complete reference, please read the documentation.

Initialize

DynamicPreferences must be initialized once before accessing its methods.

// Initialize with application context.
DynamicPreferences.initializeInstance(applicationContext);

After initializing, its various public methods can be accessed via getting the initialized instance.

Save

It supports the saving of boolean, int, String and Set<String> value types into the shared preferences.

// Save a value in the default shared preferences.
DynamicPreferences.getInstance().save(key, value);

// Save a value in the supplied shared preferences.
DynamicPreferences.getInstance().save(preferences, key, value);

Load

It supports the retrieval of boolean, int, String and Set<String> value types from the shared preferences.

// Retrieve a value from the default shared preferences.
DynamicPreferences.getInstance().load(key, defaultValue);

// Retrieve a value from the supplied shared preferences.
DynamicPreferences.getInstance().save(preferences, key, defaultValue);

Delete

It supports the deletion of a particular key or a complete shared preferences.

// Remove a key from the default shared preferences.
DynamicPreferences.getInstance().delete(key);

// Remove a key from the supplied shared preferences.
DynamicPreferences.getInstance().delete(preferences, key);

// Delete a shared preferences.
DynamicPreferences.getInstance().deleteSharedPreference(preferences);

Dependency

It depends on the dynamic-utils to perform various internal operations. So, its functions can also be used to perform other useful operations.

---

Author

Pranav Pandey

---

License

Copyright 2019-2024 Pranav Pandey

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.