Added in API level 30

Summary: Methods | Protected Methods | Inherited Methods

ResourcesProvider

Kotlin |Java

public class ResourcesProvider
extends Object implements AutoCloseable, Closeable

java.lang.Object
↳	android.content.res.loader.ResourcesProvider

Provides methods to load resources data from APKs (.apk) and resources tables (eg. resources.arsc) for use with ResourcesLoader(s).

Summary

Public methods
`void`	`close()` Frees internal data structures.
`static ResourcesProvider`	`empty(AssetsProvider assetsProvider)` Creates an empty ResourcesProvider with no resource data.
`static ResourcesProvider`	`loadFromApk(ParcelFileDescriptor fileDescriptor)` Creates a ResourcesProvider from an APK (`.apk`) file descriptor.
`static ResourcesProvider`	`loadFromApk(ParcelFileDescriptor fileDescriptor, AssetsProvider assetsProvider)` Creates a ResourcesProvider from an APK (`.apk`) file descriptor.
`static ResourcesProvider`	`loadFromDirectory(String path, AssetsProvider assetsProvider)` Creates a ResourcesProvider from a directory path.
`static ResourcesProvider`	`loadFromSplit(Context context, String splitName)` Read from a split installed alongside the application, which may not have been loaded initially because the application requested isolated split loading.
`static ResourcesProvider`	`loadFromTable(ParcelFileDescriptor fileDescriptor, AssetsProvider assetsProvider)` Creates a ResourcesProvider from a resources table (`.arsc`) file descriptor.
`static ResourcesProvider`	`loadOverlay(OverlayInfo overlayInfo)` Creates a ResourcesProvider instance from the specified overlay information.

Protected methods
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          java.lang.AutoCloseable


      close()

Closes this resource, relinquishing any underlying resources.

From interface


        
          java.io.Closeable


      close()

Closes this stream and releases any system resources associated with it.

Public methods

close

Added in API level 30

public void close ()

Frees internal data structures. Closed providers can no longer be added to ResourcesLoader(s).

Throws
`IllegalStateException`	if provider is currently used by a ResourcesLoader

empty

Added in API level 30

public static ResourcesProvider empty (AssetsProvider assetsProvider)

Creates an empty ResourcesProvider with no resource data. This is useful for loading file-based assets not associated with resource identifiers.

Parameters
`assetsProvider`	`AssetsProvider`: the assets provider that implements the loading of file-based resources This value cannot be `null`.

Returns
`ResourcesProvider`	This value cannot be `null`.

loadFromApk

Added in API level 30

public static ResourcesProvider loadFromApk (ParcelFileDescriptor fileDescriptor)

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`: the file descriptor of the APK to load This value cannot be `null`.

Returns
`ResourcesProvider`	This value cannot be `null`.

Throws
`IOException`

See also:

loadFromApk

Added in API level 30

public static ResourcesProvider loadFromApk (ParcelFileDescriptor fileDescriptor, 
                AssetsProvider assetsProvider)

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`: the file descriptor of the APK to load This value cannot be `null`.
`assetsProvider`	`AssetsProvider`: the assets provider that overrides the loading of file-based resources This value may be `null`.

Returns
`ResourcesProvider`	This value cannot be `null`.

Throws
`IOException`

See also:

loadFromDirectory

Added in API level 30

public static ResourcesProvider loadFromDirectory (String path, 
                AssetsProvider assetsProvider)

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`: the path of the directory to treat as an APK This value cannot be `null`.
`assetsProvider`	`AssetsProvider`: the assets provider that overrides the loading of file-based resources This value may be `null`.

Returns
`ResourcesProvider`	This value cannot be `null`.

Throws
`IOException`

loadFromSplit

Added in API level 30

public static ResourcesProvider loadFromSplit (Context context, 
                String splitName)

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`: a context of the package that contains the split This value cannot be `null`.
`splitName`	`String`: the name of the split to load This value cannot be `null`.

Returns
`ResourcesProvider`	This value cannot be `null`.

Throws
`IOException`

loadFromTable

Added in API level 30

public static ResourcesProvider loadFromTable (ParcelFileDescriptor fileDescriptor, 
                AssetsProvider assetsProvider)

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`: the file descriptor of the resources table to load This value cannot be `null`.
`assetsProvider`	`AssetsProvider`: the assets provider that implements the loading of file-based resources This value may be `null`.

Returns
`ResourcesProvider`	This value cannot be `null`.

Throws
`IOException`

See also:

loadOverlay

Added in API level 34

public static ResourcesProvider loadOverlay (OverlayInfo overlayInfo)

Creates a ResourcesProvider instance from the specified overlay information.

In order to enable the registered overlays, an application can create a ResourcesProvider instance according to the specified OverlayInfo instance and put them into a ResourcesLoader instance. The application calls Resources.addLoaders(ResourcesLoader) to load the overlays.

Parameters
`overlayInfo`	`OverlayInfo`: is the information about the specified overlay This value cannot be `null`.

Returns
`ResourcesProvider`	the resources provider instance for the `overlayInfo` This value cannot be `null`.

Throws
`IOException`	when the files can't be loaded.

See also:

to get the list of overlay info.

Protected methods

finalize

Added in API level 30

protected void finalize ()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Throws
`Throwable`