public final class AssetManager extends Object
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.| Modifier and Type | Class and Description |
|---|---|
class |
AssetManager.AssetInputStream |
| Modifier and Type | Field and Description |
|---|---|
static int |
ACCESS_BUFFER
Mode for
open(String, int): Attempt to load contents into
memory, for fast small reads. |
static int |
ACCESS_RANDOM
Mode for
open(String, int): Read chunks, and seek forward and
backward. |
static int |
ACCESS_STREAMING
Mode for
open(String, int): Read sequentially, with an
occasional forward seek. |
static int |
ACCESS_UNKNOWN
Mode for
open(String, int): no specific information about how
data will be accessed. |
| Constructor and Description |
|---|
AssetManager()
Create a new AssetManager containing only the basic system assets.
|
| Modifier and Type | Method and Description |
|---|---|
int |
addAssetPath(String path)
Add an additional set of assets to the asset manager.
|
int[] |
addAssetPaths(String[] paths)
Add multiple sets of assets to the asset manager at once.
|
void |
close()
Close this asset manager.
|
protected void |
finalize()
Invoked when the garbage collector has detected that this instance is no longer reachable.
|
static String |
getAssetAllocations() |
String |
getCookieName(int cookie) |
static int |
getGlobalAssetCount() |
static int |
getGlobalAssetManagerCount() |
String[] |
getLocales()
Get the locales that this asset manager contains data for.
|
static AssetManager |
getSystem()
Return a global shared asset manager that provides access to only
system assets (no application assets).
|
boolean |
isUpToDate()
Determine whether the state in this asset manager is up-to-date with
the files on the filesystem.
|
String[] |
list(String path)
Return a String array of all the assets at the given path.
|
InputStream |
open(String fileName)
Open an asset using ACCESS_STREAMING mode.
|
InputStream |
open(String fileName,
int accessMode)
Open an asset using an explicit access mode, returning an InputStream to
read its contents.
|
AssetFileDescriptor |
openFd(String fileName) |
InputStream |
openNonAsset(int cookie,
String fileName)
Open a non-asset in a specified package.
|
InputStream |
openNonAsset(int cookie,
String fileName,
int accessMode)
Open a non-asset in a specified package.
|
InputStream |
openNonAsset(String fileName)
Open a non-asset file as an asset using ACCESS_STREAMING mode.
|
InputStream |
openNonAsset(String fileName,
int accessMode)
Open a non-asset file as an asset using a specific access mode.
|
AssetFileDescriptor |
openNonAssetFd(int cookie,
String fileName) |
AssetFileDescriptor |
openNonAssetFd(String fileName) |
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.
|
void |
setConfiguration(int mcc,
int mnc,
String locale,
int orientation,
int touchscreen,
int density,
int keyboard,
int keyboardHidden,
int navigation,
int screenWidth,
int screenHeight,
int smallestScreenWidthDp,
int screenWidthDp,
int screenHeightDp,
int screenLayout,
int uiMode,
int majorVersion)
Change the configuation used when retrieving resources.
|
void |
setLocale(String locale)
Change the locale being used by this asset manager.
|
public static final int ACCESS_UNKNOWN
open(String, int): no specific information about how
data will be accessed.public static final int ACCESS_RANDOM
open(String, int): Read chunks, and seek forward and
backward.public static final int ACCESS_STREAMING
open(String, int): Read sequentially, with an
occasional forward seek.public static final int ACCESS_BUFFER
open(String, int): Attempt to load contents into
memory, for fast small reads.public AssetManager()
Resources.getAssets(). Not for
use by applications.
public static AssetManager getSystem()
public void close()
public final InputStream open(String fileName) throws IOException
fileName - The name of the asset to open. This name can be
hierarchical.IOExceptionopen(String, int),
list(java.lang.String)public final InputStream open(String fileName, int accessMode) throws IOException
fileName - The name of the asset to open. This name can be
hierarchical.accessMode - Desired access mode for retrieving the data.IOExceptionACCESS_UNKNOWN,
ACCESS_STREAMING,
ACCESS_RANDOM,
ACCESS_BUFFER,
open(String),
list(java.lang.String)public final AssetFileDescriptor openFd(String fileName) throws IOException
IOExceptionpublic final String[] list(String path) throws IOException
path - A relative path within the assets, i.e., "docs/home.html".IOExceptionopen(java.lang.String)public final InputStream openNonAsset(String fileName) throws IOException
IOExceptionopen(String)public final InputStream openNonAsset(String fileName, int accessMode) throws IOException
IOExceptionopen(String, int)public final InputStream openNonAsset(int cookie, String fileName) throws IOException
cookie - Identifier of the package to be opened.fileName - Name of the asset to retrieve.IOExceptionpublic final InputStream openNonAsset(int cookie, String fileName, int accessMode) throws IOException
cookie - Identifier of the package to be opened.fileName - Name of the asset to retrieve.accessMode - Desired access mode for retrieving the data.IOExceptionpublic final AssetFileDescriptor openNonAssetFd(String fileName) throws IOException
IOExceptionpublic final AssetFileDescriptor openNonAssetFd(int cookie, String fileName) throws IOException
IOExceptionpublic final XmlResourceParser openXmlResourceParser(String fileName) throws IOException
fileName - The name of the file to retrieve.IOExceptionpublic final XmlResourceParser openXmlResourceParser(int cookie, String fileName) throws IOException
cookie - Identifier of the package to be opened.fileName - The name of the file to retrieve.IOExceptionprotected void finalize()
throws Throwable
ObjectNote 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.
public final int addAssetPath(String path)
public final int[] addAssetPaths(String[] paths)
addAssetPath(String) for more information. Returns array of
cookies for each added asset with 0 indicating failure, or null if
the input array of paths is null.
public final boolean isUpToDate()
public final void setLocale(String locale)
public final String[] getLocales()
public final void setConfiguration(int mcc,
int mnc,
String locale,
int orientation,
int touchscreen,
int density,
int keyboard,
int keyboardHidden,
int navigation,
int screenWidth,
int screenHeight,
int smallestScreenWidthDp,
int screenWidthDp,
int screenHeightDp,
int screenLayout,
int uiMode,
int majorVersion)
public final String getCookieName(int cookie)
public static final int getGlobalAssetCount()
public static final String getAssetAllocations()
public static final int getGlobalAssetManagerCount()