Added in API level 1

Summary: Nested Classes | Ctors | Methods | Protected Methods | Inherited Methods

DexFile

public final class DexFile
extends Object

java.lang.Object
↳	dalvik.system.DexFile

---

Loads DEX files. This class is meant for internal use and should not be used by applications. Applications should not instantiate this class. It will hurt performance in most cases and will lead to incorrect execution of bytecode in the worst case. Applications should use one of the standard classloaders such as PathClassLoader instead. Non-static APIs will be removed in a future Android release.

Summary

Nested classes
class	DexFile.OptimizationInfo Encapsulates information about the optimizations performed on a dex file.

Public constructors
DexFile(File file) This constructor is deprecated. Applications should use one of the standard classloaders such as PathClassLoader instead. This API will be removed in a future Android release.
DexFile(String fileName) This constructor is deprecated. Applications should use one of the standard classloaders such as PathClassLoader instead. This API will be removed in a future Android release.

Public methods
void	close() This method was deprecated in API level 26. Applications should use one of the standard classloaders such as PathClassLoader instead. This API will be removed in a future Android release.
Enumeration<String>	entries() This method was deprecated in API level 26. Applications should use one of the standard classloaders such as PathClassLoader instead. This API will be removed in a future Android release.
String	getName() This method was deprecated in API level 26. Applications should use one of the standard classloaders such as PathClassLoader instead. This API will be removed in a future Android release.
static boolean	isDexOptNeeded(String fileName) This method was deprecated in API level 26. Use Artd.getDexoptNeeded instead.
Class<T>	loadClass(String name, ClassLoader loader) This method was deprecated in API level 26. Applications should use one of the standard classloaders such as PathClassLoader instead. This API will be removed in a future Android release.
static DexFile	loadDex(String sourcePathName, String outputPathName, int flags) This method was deprecated in API level 26. Applications should use one of the standard classloaders such as PathClassLoader instead. This API will be removed in a future Android release.
String	toString() Returns a string representation of the object.

Protected methods
void	finalize() Called when the class is finalized.

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.

Public constructors

DexFile

Added in API level 1

public DexFile (File file)

This constructor is deprecated.
Applications should use one of the standard classloaders such as PathClassLoader instead. This API will be removed in a future Android release.

Opens a DEX file from a given File object.

Parameters
file	File

Throws
IOException

DexFile

Added in API level 1

public DexFile (String fileName)

This constructor is deprecated.
Applications should use one of the standard classloaders such as PathClassLoader instead. This API will be removed in a future Android release.

Opens a DEX file from a given filename.

Parameters
fileName	String

Throws
IOException

Public methods

close

Added in API level 1
Deprecated in API level 26

public void close ()

This method was deprecated in API level 26.
Applications should use one of the standard classloaders such as PathClassLoader instead. This API will be removed in a future Android release.

Closes the DEX file.

This may not be able to release all of the resources. If classes from this DEX file are still resident, the DEX file can't be unmapped. In the case where we do not release all the resources, close is called again in the finalizer.

Throws
IOException	if an I/O error occurs during closing the file, which normally should not happen

entries

Added in API level 1
Deprecated in API level 26

public Enumeration<String> entries ()

This method was deprecated in API level 26.
Applications should use one of the standard classloaders such as PathClassLoader instead. This API will be removed in a future Android release.

Enumerate the names of the classes in this DEX file.

Returns
Enumeration<String>	an enumeration of names of classes contained in the DEX file, in the usual internal form (like "java/lang/String").

getName

Added in API level 1
Deprecated in API level 26

public String getName ()

This method was deprecated in API level 26.
Applications should use one of the standard classloaders such as PathClassLoader instead. This API will be removed in a future Android release.

Gets the name of the (already opened) DEX file.

Returns
String	the file name

isDexOptNeeded

Added in API level 1
Deprecated in API level 26

public static boolean isDexOptNeeded (String fileName)

This method was deprecated in API level 26.
Use Artd.getDexoptNeeded instead.

Returns true if the VM believes that the apk/jar file is out of date and should be passed through "dexopt" again.

Parameters
fileName	String: the absolute path to the apk/jar file to examine.

Returns
boolean	true if dexopt should be called on the file, false otherwise.

Throws
FileNotFoundException	if fileName is not readable, not a file, or not present.
IOException	if fileName is not a valid apk/jar file or if problems occur while parsing it.
NullPointerException	if fileName is null.

loadClass

Added in API level 1
Deprecated in API level 26

public Class<T> loadClass (String name, 
                ClassLoader loader)

This method was deprecated in API level 26.
Applications should use one of the standard classloaders such as PathClassLoader instead. This API will be removed in a future Android release.

Loads a class. Returns the class on success, or a null reference on failure.

If you are not calling this from a class loader, this is most likely not going to do what you want. Use Class#forName(String) instead.

The method does not throw ClassNotFoundException if the class isn't found because it isn't reasonable to throw exceptions wildly every time a class is not found in the first DEX file we look at.

Parameters
name	String: the class name, which should look like "java/lang/String"
loader	ClassLoader: the class loader that tries to load the class (in most cases the caller of the method

Returns
Class<T>	the Class object representing the class, or null if the class cannot be loaded

loadDex

Added in API level 3
Deprecated in API level 26

public static DexFile loadDex (String sourcePathName, 
                String outputPathName, 
                int flags)

This method was deprecated in API level 26.
Applications should use one of the standard classloaders such as PathClassLoader instead. This API will be removed in a future Android release.

Open a DEX file, specifying the file in which the optimized DEX data should be written. If the optimized form exists and appears to be current, it will be used; if not, the VM will attempt to regenerate it.

Parameters
sourcePathName	String
outputPathName	String
flags	int

Returns
DexFile

Throws
IOException

toString

Added in API level 1

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

Protected methods

finalize

Added in API level 1

protected void finalize ()

Called when the class is finalized. Makes sure the DEX file is closed.

Throws
IOException	if an I/O error occurs during closing the file, which normally should not happen
Throwable