com.android.builder.symbols

Class SymbolTable

java.lang.Object

com.android.builder.symbols.SymbolTable

@Immutable
public class SymbolTable
extends java.lang.Object

List of symbols identifying resources in an Android application. Symbol tables do not only exist for applications: they can be used for other building blocks for applications, such as libraries or atoms.

A symbol table keeps a list of instances of Symbol, each one with a unique pair class / name. Tables have two main attributes: a name and package. These should be unique and are used to generate the R.java file. Actually, the name of the table is the class name and the package is the java package so, traditionally, all symbol tables are named R.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SymbolTable.Builder Builder that creates a symbol table.

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableCollection<Symbol>	allSymbols() Obtains all symbols in the table.
static SymbolTable.Builder	builder() Creates a new builder to create a SymbolTable.
boolean	contains(java.lang.String resourceType, java.lang.String name) Checks if the table contains a symbol with the given resource type / name.
boolean	equals(java.lang.Object obj)
SymbolTable	filter(SymbolTable table) Produces a subset of this symbol table that has the symbols with resource type / name defined in filter.
java.lang.String	getTableName() Obtains the table name.
java.lang.String	getTablePackage() Obtains the table package.
int	hashCode()
static SymbolTable	merge(java.util.List<SymbolTable> tables) Merges a list of tables into a single table.
SymbolTable	merge(SymbolTable m) Short for merging this and m.
SymbolTable	rename(java.lang.String tablePackage, java.lang.String tableName) Builds a new symbol table that has the same symbols as this one, but was renamed with the given package and table name.

Methods inherited from class java.lang.Object

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

Method Detail

getTableName

@NonNull
public java.lang.String getTableName()

Obtains the table name. See class description.

Returns:

the table name

getTablePackage

@NonNull
public java.lang.String getTablePackage()

Obtains the table package. See class description.

Returns:

the table package

contains

public boolean contains(@NonNull
                        java.lang.String resourceType,
                        @NonNull
                        java.lang.String name)

Checks if the table contains a symbol with the given resource type / name.

Parameters:

resourceType - the resource type

name - the name

Returns:

does the table contain a symbol with the given resource type / name?

allSymbols

@NonNull
public com.google.common.collect.ImmutableCollection<Symbol> allSymbols()

Obtains all symbols in the table.

Returns:

all symbols

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

filter

@NonNull
public SymbolTable filter(@NonNull
                                   SymbolTable table)

Produces a subset of this symbol table that has the symbols with resource type / name defined in filter. In other words, a symbol s will exist in the result if and only if s exists in this and there is a symbol s1 in table such that s.resourceType == s1.resourceType && s.name == s1.name.

Parameters:

table - the filter table

Returns:

the filter result; this table will have the same name and package as this one

merge

@NonNull
public SymbolTable merge(@NonNull
                                  SymbolTable m)

Short for merging this and m.

Parameters:

m - the table to add to this

Returns:

the result of merging this with m

rename

@NonNull
public SymbolTable rename(@NonNull
                                   java.lang.String tablePackage,
                                   @NonNull
                                   java.lang.String tableName)

Builds a new symbol table that has the same symbols as this one, but was renamed with the given package and table name.

Parameters:

tablePackage - the table package

tableName - the table name

Returns:

the new renamed symbol table

merge

@NonNull
public static SymbolTable merge(@NonNull
                                         java.util.List<SymbolTable> tables)

Merges a list of tables into a single table. The merge is order-sensitive: when multiple symbols with the same class / name exist in multiple tables, the first one will be used.

Parameters:

tables - the tables to merge

Returns:

the table with the result of the merge; this table will have the package / name of the first table in tables, or the default one if there are no tables in tables

builder

@NonNull
public static SymbolTable.Builder builder()

Creates a new builder to create a SymbolTable.

Returns:

a builder