https://github.com/Amit7474/Dolly-SharedPreferences
https://github.com/Amit7474/Dolly-SharedPreferences
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/Amit7474/Dolly-SharedPreferences
- Owner: Amit7474
- Created: 2020-11-10T13:33:29.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-11-11T15:43:49.000Z (over 4 years ago)
- Last Synced: 2024-11-07T08:42:00.668Z (7 months ago)
- Language: Java
- Size: 137 KB
- Stars: 10
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-list - Amit7474/Dolly-SharedPreferences - (Java)
README
# Dolly for SharedPreferences
**Dolly** is a library that combines 2 types of sharedPreferences in one place:
[SharedPreferences](https://developer.android.com/reference/android/content/SharedPreferences) - Regular sharedPreferences
[EncryptedSharedPreferences](https://developer.android.com/reference/androidx/security/crypto/EncryptedSharedPreferences) - AES256 encrypted key:value SharedPreferences
**Dolly implements the logic for you, you just need to use it.**
[](https://jitpack.io/#Amit7474/Dolly-SharedPreferences)
[](https://android-arsenal.com/details/1/8189)
# Download
## Requirement
```
minSdkVersion 23
```
## Repository
Add this in your root `build.gradle` file (**not** your module `build.gradle` file):
```
allprojects {
repositories {
...
maven { url "https://jitpack.io" }
}
}
```
## Dependency
Add this to your module's `build.gradle` file (Note: version should match the jitpack badge above)
```
dependencies {
implementation 'com.github.Amit7474:Dolly-SharedPreferences:1.0.0'
}
```
# Usage
Get the instance of Dolly:
```Java
Dolly dolly = Dolly.getInstance(context);
```
Start use Dolly:
```Java
dolly.getInt("age", 20, Type.ENCRYPT);
```
## API
**`putInt(key, value, type)`**
store Int values.
```Java
dolly.putInt("Age", 23, Type.ENCRYPT);
dolly.putInt("Age", 20, Type.NOT_ENCRYPT);
```
**`getInt(key, defaultValue, type)`**
get Int values.
defaultValue is optional! in case that its not supplied and the key is missing will return `-1`
```Java
dolly.getInt("Age", 5, Type.ENCRYPT);
dolly.getInt("Age", Type.NOT_ENCRYPT);
```
**`putBoolean(key, value, type)`**
store boolean values.
```Java
dolly.putBoolean("isSingle", true, Type.ENCRYPT);
dolly.putBoolean("isSingle", true, Type.NOT_ENCRYPT);
```
**`getBoolean(key, defaultValue, type)`**
get Boolean values.
defaultValue is optional! in case that its not supplied and the key is missing will return `false`
```Java
dolly.getBoolean("isSingle", Type.ENCRYPT);
dolly.getBoolean("isSingle", true, Type.NOT_ENCRYPT);
```
**`putFloat(key, value, type)`**
store float values.
```Java
dolly.putFloat("hight", 6, Type.ENCRYPT);
dolly.putFloat("hight", 8, Type.NOT_ENCRYPT);
```
**`getFloat(key, defaultValue, type)`**
get float values.
defaultValue is optional! in case that its not supplied and the key is missing will return `-1`
```Java
dolly.getFloat("hight", 50, Type.ENCRYPT);
dolly.getFloat("hight", Type.NOT_ENCRYPT);
```
**`putLong(key, value, type)`**
store long values.
```Java
dolly.putLong("hight", 6, Type.ENCRYPT);
dolly.putLong("hight", 8, Type.NOT_ENCRYPT);
```
**`getLong(key, defaultValue, type)`**
get long values.
defaultValue is optional! in case that its not supplied and the key is missing will return `-1`
```Java
dolly.getLong("hight", 50, Type.ENCRYPT);
dolly.getLong("hight", Type.NOT_ENCRYPT);
```
**`putDouble(key, value, type)`**
store double values.
```Java
dolly.putDouble("length", 6.5, Type.ENCRYPT);
dolly.putDouble("hight",10.0, Type.NOT_ENCRYPT);
```
**`getDouble(key, defaultValue, type)`**
get double values.
defaultValue is optional! in case that its not supplied and the key is missing will return `-1`
```Java
dolly.getDouble("hight", 50, Type.ENCRYPT);
dolly.getDouble("hight", Type.NOT_ENCRYPT);
```
**`putString(key, value, type)`**
store string values.
```Java
dolly.putString("name", "Dani", Type.ENCRYPT);
dolly.putString("name","Dani", Type.NOT_ENCRYPT);
```
**`getString(key, defaultValue, type)`**
get string values.
defaultValue is optional! in case that its not supplied and the key is missing will return `"null"`
```Java
dolly.getString("hight", "null", Type.ENCRYPT);
dolly.getString("hight", Type.NOT_ENCRYPT);
```
**`putStringSet(key, value, type)`**
store string set values.
```Java
Set set = new Set();
dolly.putStringSet("set", set, Type.ENCRYPT);
dolly.putStringSet("set",set, Type.NOT_ENCRYPT);
```
**`getStringSet(key, defaultValue, type)`**
get string values.
defaultValue is optional! in case that its not supplied and the key is missing will return `null`
```Java
dolly.getStringSet("set", null, Type.ENCRYPT);
dolly.getStringSet("set", Type.NOT_ENCRYPT);
```
**`putJsonObject(key, value, type)`**
store JSONObject values.
```Java
JSONObject obj = new JSONObject;
obj.put("name", "Dani");
dolly.putJsonObject("json", obj, Type.ENCRYPT);
dolly.putJsonObject("json",obj, Type.NOT_ENCRYPT);
```
**`getJsonObject(key, defaultValue, type)`**
get JSONObject values.
defaultValue is optional! in case that its not supplied and the key is missing will return `null`
```Java
dolly.getJsonObject("json", null, Type.ENCRYPT);
dolly.getJsonObject("json", Type.NOT_ENCRYPT);
```
**`remove(key, type)`**
use this to remove a key:value pair from storage.
It will remove ONLY from the storage that you specify! (ENCRYPT/NPT_ENCRYPT)
```Java
dolly.remove("name", Type.ENCRYPT);
```
**`contains(key)`**
checks if a key is already stored in storage (BOTH encrypt/not encrypt) .
```Java
dolly.contains("json");
```
**`removeAll()`**
Clears the entire storage (BOTH encrypt/not encrypt) .
```Java
dolly.removeAll();
```
# License
```
Copyright (C) 2020, Amit kremer
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.
```