Falcon
📦 Thread-safe, crypto-protected, multi-level lru caching with a life cycle
Install / Use
/learn @kernel0x/FalconREADME
Falcon
A lightweight and simple library to cache any serializable objects, using the LRU algorithm, two storage levels (files, memory), encryption and life cycle.
Gradle Dependency
Add it in your root build.gradle at the end of repositories:
allprojects {
repositories {
...
maven { url "https://jitpack.io"}
}
}
Add the dependency:
dependencies {
implementation 'com.github.kernel0x:falcon:1.0.2'
}
How to use
Create an object using the builder.
Cache<Object> cache = new Cache.Builder().build(getContext());
OR with special type
Cache<Cat> cache = new Cache.Builder().build(getContext());
Available methods in the Builder
- defaultLifetime default cache lifetime
- maxSize maximum cache size (file and ram)
- caseSensitiveKeys key case sensitivity
- autoCleanup auto clean timer time
- dualCacheMode caching mode
- encryptStrategy encryption algorithm
Everything is simple. Now you can cache something. Important! Cached objects must implement Serializable
Examples:
cache.set(KEY, new Cat());
cache.set(KEY, new Cat(), DualCacheMode.ONLY_DISK);
cache.set(KEY, new Cat(), DualCacheMode.ONLY_RAM);
cache.set(KEY, new Cat(), new Duration(1, TimeUnit.SECONDS));
Features
- encryption
- cache location selection (file or memory)
- LRU, cache extrusion method
- cache lifetime selection
- thread safe
Tests
It's totally tested. Check the tests! :wink:
Releases
Checkout the Releases tab for all release info.
