com.android.builder.symbols

Class SymbolIo

java.lang.Object

com.android.builder.symbols.SymbolIo

public final class SymbolIo
extends java.lang.Object

Reads and writes symbol tables to files.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANDROID_ATTR_PREFIX

Method Summary

Modifier and Type	Method and Description
static java.io.File	exportToJava(SymbolTable table, java.io.File directory, boolean finalIds) Exports a symbol table to a java R class source.
static SymbolTable	read(java.io.File file, java.lang.String tablePackage) Loads a symbol table from a symbol file.
static SymbolTable	readFromAapt(java.io.File file, java.lang.String tablePackage) Loads a symbol table from a symbol file created by aapt
static SymbolTable	readTableWithPackage(java.io.File file) Loads a symbol table from a synthetic namespaced symbol file.
static SymbolTable	readTableWithPackage(java.nio.file.Path file)
static void	write(SymbolTable table, java.io.File file) Writes a symbol table to a symbol file.
static void	write(SymbolTable table, java.nio.file.Path file)
static void	writeSymbolTableWithPackage(java.nio.file.Path symbolTable, java.nio.file.Path manifest, java.nio.file.Path outputFile) Writes the symbol table with the package name as the first line.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ANDROID_ATTR_PREFIX

public static final java.lang.String ANDROID_ATTR_PREFIX

See Also:

Constant Field Values

Method Detail

read

@NonNull
public static SymbolTable read(@NonNull
                                        java.io.File file,
                                        @Nullable
                                        java.lang.String tablePackage)
                                 throws java.io.IOException

Loads a symbol table from a symbol file.

Parameters:

file - the symbol file

tablePackage - the package name associated with the table

Returns:

the table read

Throws:

java.io.IOException - failed to read the table

readFromAapt

@NonNull
public static SymbolTable readFromAapt(@NonNull
                                                java.io.File file,
                                                @Nullable
                                                java.lang.String tablePackage)
                                         throws java.io.IOException

Loads a symbol table from a symbol file created by aapt

Parameters:

file - the symbol file

tablePackage - the package name associated with the table

Returns:

the table read

Throws:

java.io.IOException - failed to read the table

readTableWithPackage

@NonNull
public static SymbolTable readTableWithPackage(@NonNull
                                                        java.io.File file)
                                                 throws java.io.IOException

Loads a symbol table from a synthetic namespaced symbol file.

This is just a symbol table, but with the addition of the table package as the first line.

Parameters:

file - the symbol file

Returns:

the table read

Throws:

java.io.IOException - failed to read the table

readTableWithPackage

@NonNull
public static SymbolTable readTableWithPackage(@NonNull
                                                        java.nio.file.Path file)
                                                 throws java.io.IOException

Throws:

java.io.IOException

write

public static void write(@NonNull
                         SymbolTable table,
                         @NonNull
                         java.io.File file)

Writes a symbol table to a symbol file.

Parameters:

table - the table

file - the file where the table should be written

Throws:

java.io.UncheckedIOException - I/O error

write

public static void write(@NonNull
                         SymbolTable table,
                         @NonNull
                         java.nio.file.Path file)

writeSymbolTableWithPackage

public static void writeSymbolTableWithPackage(@NonNull
                                               java.nio.file.Path symbolTable,
                                               @NonNull
                                               java.nio.file.Path manifest,
                                               @NonNull
                                               java.nio.file.Path outputFile)
                                        throws java.io.IOException

Writes the symbol table with the package name as the first line.

Parameters:

symbolTable - The R.txt file. If it does not exist, the result will be a file containing only the package name

manifest - The AndroidManifest.xml file for this library. The package name is extracted and written as the first line of the output.

outputFile - The file to write the result to.

Throws:

java.io.IOException

exportToJava

@NonNull
public static java.io.File exportToJava(@NonNull
                                                 SymbolTable table,
                                                 @NonNull
                                                 java.io.File directory,
                                                 boolean finalIds)

Exports a symbol table to a java R class source. This method will create the source file and any necessary directories. For example, if the package is a.b and the class name is RR, this method will generate a file called RR.java in directory directory/a/b creating directories a and b if necessary.

Parameters:

table - the table to export

directory - the directory where the R source should be generated

finalIds - should the generated IDs be final?

Returns:

the generated file

Throws:

java.io.UncheckedIOException - failed to generate the source