com.android.builder.symbols

Class SymbolTable

java.lang.Object

com.android.builder.symbols.SymbolTable

public abstract 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 one main attribute: a package name. This should be unique and are used to generate the R.java file.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	R_CLASS_NAME Name of R class.

Constructor Summary

Constructors

Constructor and Description
SymbolTable()

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(com.android.resources.ResourceType resourceType, java.lang.String name) Checks if the table contains a symbol with the given resource type / name.
SymbolTable	filter(SymbolTable table) Produces a subset of this symbol table that has the symbols with resource type / name defined in filter.
abstract com.google.common.collect.ImmutableMap<java.lang.String,Symbol>	getSymbols()
abstract java.lang.String	getTablePackage() Obtains the table package.
static java.lang.String	key(com.android.resources.ResourceType resourceType, java.lang.String name) Obtains a unique key for a resource type / name.
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) Builds a new symbol table that has the same symbols as this one, but was renamed with the given package.

Methods inherited from class java.lang.Object

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

Field Detail

R_CLASS_NAME

public static final java.lang.String R_CLASS_NAME

Name of R class.

See Also:

Constant Field Values

Constructor Detail

SymbolTable

public SymbolTable()

Method Detail

getTablePackage

@NonNull
public abstract java.lang.String getTablePackage()

Obtains the table package. See class description.

Returns:

the table package

getSymbols

public abstract com.google.common.collect.ImmutableMap<java.lang.String,Symbol> getSymbols()

key

@NonNull
public static java.lang.String key(@NonNull
                                            com.android.resources.ResourceType resourceType,
                                            @NonNull
                                            java.lang.String name)

Obtains a unique key for a resource type / name.

Parameters:

resourceType - the resource type

name - the name

Returns:

the unique ID

contains

public boolean contains(@NonNull
                        com.android.resources.ResourceType 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

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)

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

Parameters:

tablePackage - the table package

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 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