AssetManager
public final class AssetManager
extends Object implements AutoCloseable
| java.lang.Object | |
| ↳ | android.content.res.AssetManager |
Provides access to an application's raw asset files; see Resources for the way most applications will want to retrieve their resource data. This class presents a lower-level API that allows you to open and read raw files that have been bundled with the application as a simple stream of bytes.
Summary
Nested classes | |
|---|---|
class | AssetManager.AssetInputStream
|
Constants | |
|---|---|
int | ACCESS_BUFFER Mode for |
int | ACCESS_RANDOM Mode for |
int | ACCESS_STREAMING Mode for |
int | ACCESS_UNKNOWN Mode for |
Public methods | |
|---|---|
void | close() Close this asset manager. |
String[] | getLocales() Get the locales that this asset manager contains data for. |
String[] | list(String path) Return a String array of all the assets at the given path. |
InputStream | open(String fileName, int accessMode) Open an asset using an explicit access mode, returning an InputStream to read its contents. |
InputStream | open(String fileName) Open an asset using ACCESS_STREAMING mode. |
AssetFileDescriptor | openFd(String fileName) Open an uncompressed asset by mmapping it and returning an |
AssetFileDescriptor | openNonAssetFd(String fileName) Open a non-asset as an asset by mmapping it and returning an |
AssetFileDescriptor | openNonAssetFd(int cookie, String fileName) Open a non-asset as an asset by mmapping it and returning an |
XmlResourceParser | openXmlResourceParser(int cookie, String fileName) Retrieve a parser for a compiled XML file. |
XmlResourceParser | openXmlResourceParser(String fileName) Retrieve a parser for a compiled XML file. |
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 | |
|---|---|
Constants
ACCESS_BUFFER
public static final int ACCESS_BUFFER
Mode for open(java.lang.String, int): Attempt to load contents into memory, for fast small reads.
Constant Value: 3 (0x00000003)
ACCESS_RANDOM
public static final int ACCESS_RANDOM
Mode for open(java.lang.String, int): Read chunks, and seek forward and backward.
Constant Value: 1 (0x00000001)
ACCESS_STREAMING
public static final int ACCESS_STREAMING
Mode for open(java.lang.String, int): Read sequentially, with an occasional forward seek.
Constant Value: 2 (0x00000002)
ACCESS_UNKNOWN
public static final int ACCESS_UNKNOWN
Mode for open(java.lang.String, int): no specific information about how data will be accessed.
Constant Value: 0 (0x00000000)
Public methods
getLocales
public String[] getLocales ()
Get the locales that this asset manager contains data for.
On SDK 21 (Android 5.0: Lollipop) and above, Locale strings are valid BCP-47 language tags and can be parsed using Locale.forLanguageTag(String).
On SDK 20 (Android 4.4W: KitKat for watches) and below, locale strings are of the form ll_CC where ll is a two letter language code, and CC is a two letter country code.
| Returns | |
|---|---|
String[] | |
list
public String[] list (String path)
Return a String array of all the assets at the given path.
| Parameters | |
|---|---|
path | String: A relative path within the assets, i.e., "docs/home.html". This value cannot be null. |
| Returns | |
|---|---|
String[] | String[] Array of strings, one for each asset. These file names are relative to 'path'. You can open the file by concatenating 'path' and a name in the returned string (via File) and passing that to open(). This value may be null. |
| Throws | |
|---|---|
IOException | |
See also:
open
public InputStream open (String fileName, int accessMode)
Open an asset using an explicit access mode, returning an InputStream to read its contents. This provides access to files that have been bundled with an application as assets -- that is, files placed in to the "assets" directory.
| Parameters | |
|---|---|
fileName | String: The name of the asset to open. This name can be hierarchical. This value cannot be null. |
accessMode | int: Desired access mode for retrieving the data. |
| Returns | |
|---|---|
InputStream | This value cannot be null. |
| Throws | |
|---|---|
IOException | |
open
public InputStream open (String fileName)
Open an asset using ACCESS_STREAMING mode. This provides access to files that have been bundled with an application as assets -- that is, files placed in to the "assets" directory.
| Parameters | |
|---|---|
fileName | String: The name of the asset to open. This name can be hierarchical. This value cannot be null. |
| Returns | |
|---|---|
InputStream | This value cannot be null. |
| Throws | |
|---|---|
IOException | |
See also:
openFd
public AssetFileDescriptor openFd (String fileName)
Open an uncompressed asset by mmapping it and returning an AssetFileDescriptor. This provides access to files that have been bundled with an application as assets -- that is, files placed in to the "assets" directory. The asset must be uncompressed, or an exception will be thrown.
| Parameters | |
|---|---|
fileName | String: The name of the asset to open. This name can be hierarchical. This value cannot be null. |
| Returns | |
|---|---|
AssetFileDescriptor | An open AssetFileDescriptor. This value cannot be null. |
| Throws | |
|---|---|
IOException | |
openNonAssetFd
public AssetFileDescriptor openNonAssetFd (String fileName)
Open a non-asset as an asset by mmapping it and returning an AssetFileDescriptor. This provides direct access to all of the files included in an application package (not only its assets). Applications should not normally use this. The asset must not be compressed, or an exception will be thrown.
| Parameters | |
|---|---|
fileName | String: Name of the asset to retrieve. This value cannot be null. |
| Returns | |
|---|---|
AssetFileDescriptor | This value cannot be null. |
| Throws | |
|---|---|
IOException | |
openNonAssetFd
public AssetFileDescriptor openNonAssetFd (int cookie, String fileName)
Open a non-asset as an asset by mmapping it and returning an AssetFileDescriptor. This provides direct access to all of the files included in an application package (not only its assets). Applications should not normally use this. The asset must not be compressed, or an exception will be thrown.
| Parameters | |
|---|---|
cookie | int: Identifier of the package to be opened. |
fileName | String: Name of the asset to retrieve. This value cannot be null. |
| Returns | |
|---|---|
AssetFileDescriptor | This value cannot be null. |
| Throws | |
|---|---|
IOException | |
openXmlResourceParser
public XmlResourceParser openXmlResourceParser (int cookie, String fileName)
Retrieve a parser for a compiled XML file.
| Parameters | |
|---|---|
cookie | int: Identifier of the package to be opened. |
fileName | String: The name of the file to retrieve. This value cannot be null. |
| Returns | |
|---|---|
XmlResourceParser | This value cannot be null. |
| Throws | |
|---|---|
IOException | |
openXmlResourceParser
public XmlResourceParser openXmlResourceParser (String fileName)
Retrieve a parser for a compiled XML file.
| Parameters | |
|---|---|
fileName | String: The name of the file to retrieve. This value cannot be null. |
| Returns | |
|---|---|
XmlResourceParser | This value cannot be null. |
| Throws | |
|---|---|
IOException | |
Protected methods
finalize
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 | |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.