- Breaking changes compared to
v2.1.0. - Encryption is not coming with the library itself anymore. It's developer specific now.
-
SmartStoreXis now completely storage (CacheDir/FilesDir/Others) based, no moreSharedPrefusages. - New configuration
StoreXSmartConfigto work withSmartStoreX.
Add the JitPack repository to your build file .
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}Add the dependency.
dependencies {
implementation 'com.github.rommansabbir:StoreX:3.0.0'
}How to Access SmartStoreX.
- First, create an instance of
StoreXSmartConfig:
val testConfig = StoreXSmartConfig(
WeakReference(this),
"filename",
StoreAbleObject(), //Object to be saved, must be a instance of StoreAbleObject.
StoreXCachingStrategy.CacheDir, // Caching directory: CacheDir-FilesDir-Others
overwriteExistingFile = true
)- To write an object :
val isWriteDone = SmartStoreX.getInstance.write(testConfig)
Log.d("Write Object", isWriteDone.toString())- To get a written object :
val storedObject: StoreAbleObject? =
SmartStoreX.getInstance.read(testConfig, StoreAbleObject::class.java)
Log.d("Written Object", "Object ID: " + (storedObject?.objectId ?: "null"))- To delete a written object :
val isDeleted = SmartStoreX.getInstance.delete(testConfig)
Log.d("Is Delete Done", isDeleted.toString())How to manage Subscription (Write/Delete).
- To register a subscriber :
SmartStoreX.registerSubscriber(
testConfig.fileName,
subscriber = object : StoreXSubscription {
override fun <T : StoreAbleObject> onCallback(fileName: String, updatedObject: T) {
Log.d("Write Callback", updatedObject.objectId)
}
override fun <T : StoreAbleObject> onDelete(fileName: String, deletedObject: T) {
Log.d("Delete Callback", deletedObject.objectId)
}
})- To remove a subscriber :
SmartStoreX.removeSubscriber(testConfig.fileName)- To remove all subscribers :
SmartStoreX.removeAllSubscriber()-
Objectsthat are extended fromStoreAbleObject:
StoreAbleString("Value")
StoreAbleInt(1)
StoreAbleDouble(1.0)
StoreAbleLong(1234567890879)
StoreAbleByte(Byte)
StoreAbleChar(Char)
StoreAbleShort(Short
StoreAbleArrayList(Arraylist)
StoreAbleMutableList(MutableList)
StoreAbleSet(Set)
StoreAbleMutableSet(MutableSet)
StoreAbleHashMap(HashMap)
StoreAbleHashSet(HashSet)
Looking for old version documentation? Click here to see.
✔ Website
Copyright (C) 2023 Romman Sabbir
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.