com.android.builder.dexing

Interface DexArchive

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

NonIncrementalJarDexArchive

public interface DexArchive
extends java.io.Closeable

Interface describing the DEX archive. It contains one DEX file per .class file that was processed i.e. each DEX file in it, contains definition of exactly one class. Also, the directory structure is preserved e.g. if a file com/example/tools/A.class was processed, it will have relative path com/example/tools/A.dex in the archive.

Dex archives can be updated by adding new files, or removing existing ones.

When using instances of DexArchive make sure that you invoke Closeable.close() after you are done using it.

Method Summary

Modifier and Type	Method and Description
void	addFile(java.nio.file.Path relativePath, byte[] bytes, int offset, int end) Adds a DEX file to this dex archive from a byte[].
void	addFile(java.nio.file.Path relativePath, java.io.InputStream inputStream) Adds a DEX file to this dex archive.
java.util.List<DexArchiveEntry>	getFiles() Returns collection of all entries, DexArchiveEntry, in this dex archive.
java.nio.file.Path	getRootPath() Returns the path to this DEX archive.
void	removeFile(java.nio.file.Path relativePath) Removes the specified DEX file from the dex archive.

Methods inherited from interface java.io.Closeable

close

Method Detail

getRootPath

@NonNull
java.nio.file.Path getRootPath()

Returns the path to this DEX archive.

Returns:

path to this archive

addFile

void addFile(@NonNull
             java.nio.file.Path relativePath,
             @NonNull
             java.io.InputStream inputStream)
      throws java.io.IOException

Adds a DEX file to this dex archive. Adding is performed relative to the getRootPath(). In case file with the same relative path already exists, implementations of this method should overwrite it with the new version of the file.

Parameters:

relativePath - file to be added to this archive

inputStream - data to write

Throws:

java.io.IOException

addFile

void addFile(@NonNull
             java.nio.file.Path relativePath,
             byte[] bytes,
             int offset,
             int end)
      throws java.io.IOException

Adds a DEX file to this dex archive from a byte[]. Adding is performed relative to the getRootPath(). In case file with the same relative path already exists, implementations of this method should overwrite it with the new version of the file.

Parameters:

relativePath - file to be added to this archive

bytes - the buffer to get the dex file content from

offset - the offset for the buffer window.

end - the end of the buffer window.

Throws:

java.io.IOException - if the dex file cannot be written.

removeFile

void removeFile(@NonNull
                java.nio.file.Path relativePath)
         throws java.io.IOException

Removes the specified DEX file from the dex archive. In case the file does not exist, nothing is done.

Parameters:

relativePath - file to be removed from the dex archive, relative to the getRootPath()

Throws:

java.io.IOException

getFiles

@NonNull
java.util.List<DexArchiveEntry> getFiles()
                                           throws java.io.IOException

Returns collection of all entries, DexArchiveEntry, in this dex archive. The entries contain information about the relative path, DexArchiveEntry.getRelativePathInArchive() as well as the actual DEX file content, DexArchiveEntry.getDexFileContent().

Returns:

all entries of the archive

Throws:

java.io.IOException