com.android.ide.common.symbols

Class ResourceExtraXmlParser

java.lang.Object

com.android.ide.common.symbols.ResourceExtraXmlParser

public class ResourceExtraXmlParser
extends java.lang.Object

A parser used for finding all inline declaration of android resources in XML files.

Apart from placing files into sub-directories of the resource directory and declaring them in XML files inside the values directory, id resources can also be lazily declared in other XML files in non-values directories.

For example, inside layout/main_activity.xml we could have a line such as:

      android:id="@+id/activity_main"
 

This construction is an example of a inline declaration of a resource with the type id and name activity_main. Even though it is not declared inside a values directory, it still needs to be parsed and processed into a Symbol:

Parsing result

Java type	Resource type	Resource name	ID
int	id	activity_main	0

It is also worth noting that some resources can be declared with a prefix like aapt: or android:. Following aapt's original behaviour, we strip the type names from those prefixes. This behaviour is deprecated and might be the support for it might end in the near future.

Constructor Summary

Constructors

Constructor and Description
ResourceExtraXmlParser()

Method Summary

Modifier and Type	Method and Description
static com.android.ide.common.symbols.SymbolTable	parse(org.w3c.dom.Document xmlDocument, IdProvider idProvider) Finds all constructions of type <@code '"@+id/name"'> in the given file.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceExtraXmlParser

public ResourceExtraXmlParser()

Method Detail

parse

@NonNull
public static com.android.ide.common.symbols.SymbolTable parse(@NonNull
                                                                        org.w3c.dom.Document xmlDocument,
                                                                        @NonNull
                                                                        IdProvider idProvider)

Finds all constructions of type <@code '"@+id/name"'> in the given file.

Parameters:

xmlDocument - an xml file to parse

idProvider - the provider for IDs to assign to the resources

Returns:

the symbols for all resources in the file