Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) # ResourcesProvider *** ** * ** *** ``` open class ResourcesProvider : AutoCloseable, Closeable ``` |---|---| | [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) || | ↳ | [android.content.res.loader.ResourcesProvider](https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesProvider#) | Provides methods to load resources data from APKs (`.apk`) and resources tables (eg. `resources.arsc`) for use with `https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesLoader`. ## Summary | Public methods || |---|---| | open [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | `https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesProvider#close()()` Frees internal data structures. | | open static [ResourcesProvider](https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesProvider#) | `https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesProvider#empty(android.content.res.loader.AssetsProvider)(assetsProvider: https://developer.android.com/reference/kotlin/android/content/res/loader/AssetsProvider)` Creates an empty ResourcesProvider with no resource data. | | open static [ResourcesProvider](https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesProvider#) | `https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesProvider#loadFromApk(android.os.ParcelFileDescriptor)(fileDescriptor: https://developer.android.com/reference/kotlin/android/os/ParcelFileDescriptor.html#)` Creates a ResourcesProvider from an APK (`.apk`) file descriptor. | | open static [ResourcesProvider](https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesProvider#) | `https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesProvider#loadFromApk(android.os.ParcelFileDescriptor,%20android.content.res.loader.AssetsProvider)(fileDescriptor: https://developer.android.com/reference/kotlin/android/os/ParcelFileDescriptor.html#, assetsProvider: https://developer.android.com/reference/kotlin/android/content/res/loader/AssetsProvider?)` Creates a ResourcesProvider from an APK (`.apk`) file descriptor. | | open static [ResourcesProvider](https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesProvider#) | `https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesProvider#loadFromDirectory(kotlin.String,%20android.content.res.loader.AssetsProvider)(path: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html, assetsProvider: https://developer.android.com/reference/kotlin/android/content/res/loader/AssetsProvider?)` Creates a ResourcesProvider from a directory path. | | open static [ResourcesProvider](https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesProvider#) | `https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesProvider#loadFromSplit(android.content.Context,%20kotlin.String)(context: https://developer.android.com/reference/kotlin/android/content/Context.html#, splitName: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` Read from a split installed alongside the application, which may not have been loaded initially because the application requested isolated split loading. | | open static [ResourcesProvider](https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesProvider#) | `https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesProvider#loadFromTable(android.os.ParcelFileDescriptor,%20android.content.res.loader.AssetsProvider)(fileDescriptor: https://developer.android.com/reference/kotlin/android/os/ParcelFileDescriptor.html#, assetsProvider: https://developer.android.com/reference/kotlin/android/content/res/loader/AssetsProvider?)` Creates a ResourcesProvider from a resources table (`.arsc`) file descriptor. | | open static [ResourcesProvider](https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesProvider#) | `https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesProvider#loadOverlay(android.content.om.OverlayInfo)(overlayInfo: https://developer.android.com/reference/kotlin/android/content/om/OverlayInfo.html#)` Creates a ResourcesProvider instance from the specified overlay information. | ## Public methods ### close Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun close(): Unit ``` Frees internal data structures. Closed providers can no longer be added to `https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesLoader`. | Exceptions || |---|---| | `java.lang.Exception` | if this resource cannot be closed | | `java.io.IOException` | if an I/O error occurs | | `java.lang.IllegalStateException` | if provider is currently used by a ResourcesLoader | ### empty Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open static fun empty(assetsProvider: AssetsProvider): ResourcesProvider ``` Creates an empty ResourcesProvider with no resource data. This is useful for loading file-based assets not associated with resource identifiers. | Parameters || |---|---| | `assetsProvider` | [AssetsProvider](https://developer.android.com/reference/kotlin/android/content/res/loader/AssetsProvider): the assets provider that implements the loading of file-based resources. This value cannot be `null`. | | Return || |---|---| | `https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesProvider#` | This value cannot be `null`. | ### loadFromApk Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open static fun loadFromApk(fileDescriptor: ParcelFileDescriptor): ResourcesProvider ``` Creates a ResourcesProvider from an APK (`.apk`) file descriptor. The file descriptor is duplicated and the original may be closed by the application at any time without affecting the ResourcesProvider. | Parameters || |---|---| | `fileDescriptor` | [ParcelFileDescriptor](https://developer.android.com/reference/kotlin/android/os/ParcelFileDescriptor.html#): the file descriptor of the APK to load. This value cannot be `null`. | | Return || |---|---| | `https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesProvider#` | This value cannot be `null`. | **See Also** - `https://developer.android.com/reference/kotlin/android/os/ParcelFileDescriptor.html#open(java.io.File,%20kotlin.Int)` - `https://developer.android.com/reference/kotlin/android/system/Os.html#memfd_create(kotlin.String,%20kotlin.Int)` ### loadFromApk Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open static fun loadFromApk(     fileDescriptor: ParcelFileDescriptor,     assetsProvider: AssetsProvider? ): ResourcesProvider ``` Creates a ResourcesProvider from an APK (`.apk`) file descriptor. The file descriptor is duplicated and the original may be closed by the application at any time without affecting the ResourcesProvider. The assets provider can override the loading of files within the APK and can provide entirely new files that do not exist in the APK. | Parameters || |---|---| | `fileDescriptor` | [ParcelFileDescriptor](https://developer.android.com/reference/kotlin/android/os/ParcelFileDescriptor.html#): the file descriptor of the APK to load. This value cannot be `null`. | | `assetsProvider` | [AssetsProvider](https://developer.android.com/reference/kotlin/android/content/res/loader/AssetsProvider)?: the assets provider that overrides the loading of file-based resources. This value may be `null`. | | Return || |---|---| | `https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesProvider#` | This value cannot be `null`. | **See Also** - `https://developer.android.com/reference/kotlin/android/os/ParcelFileDescriptor.html#open(java.io.File,%20kotlin.Int)` - `https://developer.android.com/reference/kotlin/android/system/Os.html#memfd_create(kotlin.String,%20kotlin.Int)` ### loadFromDirectory Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open static fun loadFromDirectory(     path: String,     assetsProvider: AssetsProvider? ): ResourcesProvider ``` Creates a ResourcesProvider from a directory path. File-based resources will be resolved within the directory as if the directory is an APK. | Parameters || |---|---| | `path` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html): the path of the directory to treat as an APK. This value cannot be `null`. | | `assetsProvider` | [AssetsProvider](https://developer.android.com/reference/kotlin/android/content/res/loader/AssetsProvider)?: the assets provider that overrides the loading of file-based resources. This value may be `null`. | | Return || |---|---| | `https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesProvider#` | This value cannot be `null`. | ### loadFromSplit Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open static fun loadFromSplit(     context: Context,     splitName: String ): ResourcesProvider ``` Read from a split installed alongside the application, which may not have been loaded initially because the application requested isolated split loading. | Parameters || |---|---| | `context` | [Context](https://developer.android.com/reference/kotlin/android/content/Context.html#): a context of the package that contains the split. This value cannot be `null`. | | `splitName` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html): the name of the split to load. This value cannot be `null`. | | Return || |---|---| | `https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesProvider#` | This value cannot be `null`. | ### loadFromTable Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open static fun loadFromTable(     fileDescriptor: ParcelFileDescriptor,     assetsProvider: AssetsProvider? ): ResourcesProvider ``` Creates a ResourcesProvider from a resources table (`.arsc`) file descriptor. The file descriptor is duplicated and the original may be closed by the application at any time without affecting the ResourcesProvider. The resources table format is not an archive format and therefore cannot asset files within itself. The assets provider can instead provide files that are potentially referenced by path in the resources table. | Parameters || |---|---| | `fileDescriptor` | [ParcelFileDescriptor](https://developer.android.com/reference/kotlin/android/os/ParcelFileDescriptor.html#): the file descriptor of the resources table to load. This value cannot be `null`. | | `assetsProvider` | [AssetsProvider](https://developer.android.com/reference/kotlin/android/content/res/loader/AssetsProvider)?: the assets provider that implements the loading of file-based resources. This value may be `null`. | | Return || |---|---| | `https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesProvider#` | This value cannot be `null`. | **See Also** - `https://developer.android.com/reference/kotlin/android/os/ParcelFileDescriptor.html#open(java.io.File,%20kotlin.Int)` - `https://developer.android.com/reference/kotlin/android/system/Os.html#memfd_create(kotlin.String,%20kotlin.Int)` ### loadOverlay Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open static fun loadOverlay(overlayInfo: OverlayInfo): ResourcesProvider ``` Creates a ResourcesProvider instance from the specified overlay information. In order to enable the registered overlays, an application can create a `https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesProvider#` instance according to the specified `https://developer.android.com/reference/kotlin/android/content/om/OverlayInfo.html#` instance and put them into a `https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesLoader` instance. The application calls `https://developer.android.com/reference/kotlin/android/content/res/Resources.html#addLoaders(android.content.res.loader.ResourcesLoader)` to load the overlays. | Parameters || |---|---| | `overlayInfo` | [OverlayInfo](https://developer.android.com/reference/kotlin/android/content/om/OverlayInfo.html#): is the information about the specified overlay. This value cannot be `null`. | | Return || |---|---| | `https://developer.android.com/reference/kotlin/android/content/res/loader/ResourcesProvider#` | the resources provider instance for the `overlayInfo` This value cannot be `null`. | | Exceptions || |---|---| | `java.io.IOException` | when the files can't be loaded. | **See Also** - `https://developer.android.com/reference/kotlin/android/content/om/OverlayManager.html#getOverlayInfosForTarget(kotlin.String)`