DocumentFileX
java.io.File compatible SAF implementation
Tired of SAF bullshits? Implement SAF with ease!
This library is in alpha stage. Most features are working, but some features might not work as intended.
Features
- Interoperable with java.io.File with some exceptions
- File.getName() without overhead
- Faster Directory IO
- Get child FileX without overhead
- Slightly improved listFiles() //√evil
- Automatic URI type detection
- File metadata caching
- Useful URI extensions
- (WIP) kotlin-stdlib File extension compatible extension methods
Setup
dependencies {
implementation 'xyz.quaver:documentfilex:0.7.1'
}
Sample Code
File I/O
⚠️ You have to use File I/O methods declared inxyz.quaver.io.util.*
Default kotlin extension methods do not work with SAFileX Instances.
val file = FileX(context, uri)
file.writeText("Hello, SAF! You're dumb.")
val text = file.readText() // "Hello, SAF! You're dumb."
val data = listOf(0x82, 0x72, 0x82, 0x60, 0x82, 0x65, 0x82, 0xA4, 0x82, 0xF1, 0x82, 0xBF).map {
it.toByte()
}.toByteArray()
file.writeBytes(data)
val text = file.readText(data, Charset.forName(<small quiz for you>))
Directory I/O
Directory I/O is supported by tree://... URI
val folder = FileX(context, uri, "akita") // No overhead
val child = folder.getChild("daisen") // No overhead
val neighbor = FileX(context, folder.parent, "yamagata") // No overhead
val neice = folder.getNeighbor("iwate/morioka/nakano.txt") // No overhead
if (neice.parent.mkdirs()) {
neice.createNewFile()
neice.renameTo(FileX(context, neice.parent, "kurokawa.json"))
}
folder.listFiles().forEach { sichouson -> // Returns FileX
sichouson.list().forEach { // Returns Uri string
....
}
}
Caching
Cache is only available for the Documents URI and Tree URI
Enabling the Cache
With constructor:
FileX(..., cached=true)
With an instance: You can call invalidate() anytime you want to update Cache even when cached is false. However, cached data will only be used by the FileX instance when the property cached is true. Alternatively you can directly access the cache with FileX.cache
file.cached = true
file.invalidate()
You can update the cache with FileX.invalidate() or Cache.invalidate
Caching might impact the performance when large amounts of instances are created. Enable cache when both of these criteria are met:
- Frequent Access to the File properties
- Not a lot of instances are crated at the same time
Also note that the cache of the instances created by listFiles() are disabled to improve performance.
13 Aug 29, 2022
51 Jan 3, 2023
74 Oct 6, 2022
5.7k Dec 31, 2022
3.7k Dec 14, 2022
5.3k Jan 7, 2023
3.9k Dec 31, 2022
1.1k Jan 2, 2023
2.4k Dec 30, 2022
1.5k Dec 9, 2022
1.4k Dec 29, 2022
6 Sep 25, 2021
5 Oct 4, 2022
3.5k Jan 9, 2023
1.6k Jan 4, 2023
237 Dec 29, 2022