Skip to content

Most visited

Recently visited

navigation
Added in API level 1

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 open(String, int): Attempt to load contents into memory, for fast small reads.

int ACCESS_RANDOM

Mode for open(String, int): Read chunks, and seek forward and backward.

int ACCESS_STREAMING

Mode for open(String, int): Read sequentially, with an occasional forward seek.

int ACCESS_UNKNOWN

Mode for open(String, int): no specific information about how data will be accessed.

Public methods

void close()

Close this asset manager.

final String[] getLocales()

Get the locales that this asset manager contains data for.

final String[] list(String path)

Return a String array of all the assets at the given path.

final InputStream open(String fileName)

Open an asset using ACCESS_STREAMING mode.

final InputStream open(String fileName, int accessMode)

Open an asset using an explicit access mode, returning an InputStream to read its contents.

final AssetFileDescriptor openFd(String fileName)
final AssetFileDescriptor openNonAssetFd(String fileName)
final AssetFileDescriptor openNonAssetFd(int cookie, String fileName)
final XmlResourceParser openXmlResourceParser(String fileName)

Retrieve a parser for a compiled XML file.

final XmlResourceParser openXmlResourceParser(int cookie, String fileName)

Retrieve a parser for a compiled XML file.

Protected methods

void finalize()

Invoked when the garbage collector has detected that this instance is no longer reachable.

Inherited methods

From class java.lang.Object
From interface java.lang.AutoCloseable

Constants

ACCESS_BUFFER

Added in API level 1
int ACCESS_BUFFER

Mode for open(String, int): Attempt to load contents into memory, for fast small reads.

Constant Value: 3 (0x00000003)

ACCESS_RANDOM

Added in API level 1
int ACCESS_RANDOM

Mode for open(String, int): Read chunks, and seek forward and backward.

Constant Value: 1 (0x00000001)

ACCESS_STREAMING

Added in API level 1
int ACCESS_STREAMING

Mode for open(String, int): Read sequentially, with an occasional forward seek.

Constant Value: 2 (0x00000002)

ACCESS_UNKNOWN

Added in API level 1
int ACCESS_UNKNOWN

Mode for open(String, int): no specific information about how data will be accessed.

Constant Value: 0 (0x00000000)

Public methods

close

Added in API level 1
void close ()

Close this asset manager.

getLocales

Added in API level 1
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 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

Added in API level 1
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".
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().
Throws
IOException

See also:

open

Added in API level 1
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.
Returns
InputStream
Throws
IOException

See also:

open

Added in API level 1
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.
accessMode int: Desired access mode for retrieving the data.
Returns
InputStream
Throws
IOException

See also:

openFd

Added in API level 1
AssetFileDescriptor openFd (String fileName)

Parameters
fileName String
Returns
AssetFileDescriptor
Throws
IOException

openNonAssetFd

Added in API level 1
AssetFileDescriptor openNonAssetFd (String fileName)

Parameters
fileName String
Returns
AssetFileDescriptor
Throws
IOException

openNonAssetFd

Added in API level 1
AssetFileDescriptor openNonAssetFd (int cookie, 
                String fileName)

Parameters
cookie int
fileName String
Returns
AssetFileDescriptor
Throws
IOException

openXmlResourceParser

Added in API level 1
XmlResourceParser openXmlResourceParser (String fileName)

Retrieve a parser for a compiled XML file.

Parameters
fileName String: The name of the file to retrieve.
Returns
XmlResourceParser
Throws
IOException

openXmlResourceParser

Added in API level 1
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.
Returns
XmlResourceParser
Throws
IOException

Protected methods

finalize

Added in API level 1
void finalize ()

Invoked when the garbage collector has detected that this instance is no longer reachable. The default implementation does nothing, but this method can be overridden to free resources.

Note that objects that override finalize are significantly more expensive than objects that don't. Finalizers may be run a long time after the object is no longer reachable, depending on memory pressure, so it's a bad idea to rely on them for cleanup. Note also that finalizers are run on a single VM-wide finalizer thread, so doing blocking work in a finalizer is a bad idea. A finalizer is usually only necessary for a class that has a native peer and needs to call a native method to destroy that peer. Even then, it's better to provide an explicit close method (and implement Closeable), and insist that callers manually dispose of instances. This works well for something like files, but less well for something like a BigInteger where typical calling code would have to deal with lots of temporaries. Unfortunately, code that creates lots of temporaries is the worst kind of code from the point of view of the single finalizer thread.

If you must use finalizers, consider at least providing your own ReferenceQueue and having your own thread process that queue.

Unlike constructors, finalizers are not automatically chained. You are responsible for calling super.finalize() yourself.

Uncaught exceptions thrown by finalizers are ignored and do not terminate the finalizer thread. See Effective Java Item 7, "Avoid finalizers" for more.

Throws
Throwable
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.