https://github.com/solkin/disk-lru-cache
💾 Disk LRU cache with persisted journal
https://github.com/solkin/disk-lru-cache
android-lib android-library cache disk-cache disk-lru disk-lru-cache disklrucache file-cache journal lru lru-cache
Last synced: 4 months ago
JSON representation
💾 Disk LRU cache with persisted journal
- Host: GitHub
- URL: https://github.com/solkin/disk-lru-cache
- Owner: solkin
- License: mit
- Created: 2018-08-26T13:29:04.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-02-23T11:33:24.000Z (7 months ago)
- Last Synced: 2025-05-27T12:46:42.569Z (4 months ago)
- Topics: android-lib, android-library, cache, disk-cache, disk-lru, disk-lru-cache, disklrucache, file-cache, journal, lru, lru-cache
- Homepage:
- Size: 434 KB
- Stars: 26
- Watchers: 3
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Disk LRU Cache [](https://jitpack.io/#solkin/disk-lru-cache) []( https://android-arsenal.com/details/1/7454 )
Disk LRU (least recently used) cache with persisted journal.
This cache has specific capacity and location.
Rarely requested files are evicted by actively used.
Lightweight and extremely easy to use.
### Add dependency
**Step 1.** Add the JitPack repository to your build file
```groovy
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
**Step 2.** Add the dependency
```groovy
implementation 'com.github.solkin:disk-lru-cache:1.4'
```
### Create DiskLruCache
```java
long CACHE_SIZE = 500 * 1024; // Size in bytes
DiskLruCache cache = DiskLruCache.create(getCacheDir(), CACHE_SIZE);
```
### Add file into cache
To manage some files by cache you just need to invoke `put` method like any `Map`.
Key - any string to request this file from cache.
File - file, that will be moved into cache.
```java
String key = "some-key";
File file = File.createTempFile("random", ".dat");
cache.put(key, file);
```
### Getting file from cache
To get file from cache, just invoke `get` method. Yes, also like any `Map`.
Key is the same you put this file into cache
This method will return `File` you put into cache or `null`, if file was evicted from cache.
```java
String key = "some-key";
File file = cache.get(key);
```
### Delete file from cache
To delete file from cache, just invoke `delete` method.
Key is the same you put this file into cache
File will be deleted from cache and from journal.
```java
String key = "some-key";
cache.delete(key);
```
### Clear cache
Sometime you may need to clear whole cache and drop all stored files.
```java
cache().clearCache();
```
### List keys in cache
To get all keys, managed by cache, invoke `keySet()` method.
This will return `Set`.
List all keys in cache may be useful to check all files, stored in cache.
```java
Set keys = cache.keySet();
```
### Get cache status information
There are some useful cache status information, that you can request.
```java
cache.getCacheSize(); // Cache size in bytes, that you set up on cache creation.
cache.getUsedSpace(); // Size of all files, stored in cache.
cache.getFreeSpace(); // Free size in cache.
cache.getJournalSize(); // Internal cache journal size in bytes.
```
### License
MIT License
Copyright (c) 2022 Igor Solkin
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.