com.android.ide.common.rendering.api

Interface XmlParserFactory

All Known Implementing Classes:

LayoutlibCallback

public interface XmlParserFactory

Factory for creation of XML pull parsers.

Method Summary

Modifier and Type	Method and Description
org.xmlpull.v1.XmlPullParser	createXmlParser() Creates and returns an XmlPullParser.
org.xmlpull.v1.XmlPullParser	createXmlParserForFile(java.lang.String fileName) Returns an XmlPullParser for the non-PSI version of an XML file.
org.xmlpull.v1.XmlPullParser	createXmlParserForPsiFile(java.lang.String fileName) Returns an XmlPullParser for the PSI version of an XML file.

Method Detail

createXmlParserForPsiFile

@Nullable
org.xmlpull.v1.XmlPullParser createXmlParserForPsiFile(@NonNull
                                                                 java.lang.String fileName)

Returns an XmlPullParser for the PSI version of an XML file.

The call to the method should be guarded by a check for RenderParamsFlag.FLAG_KEY_XML_FILE_PARSER_SUPPORT.

Parameters:

fileName - name of the file to parse

Returns:

the XML pull parser for the file, or null if the PSI file with the given name is not found

createXmlParserForFile

@Nullable
org.xmlpull.v1.XmlPullParser createXmlParserForFile(@NonNull
                                                              java.lang.String fileName)

Returns an XmlPullParser for the non-PSI version of an XML file.

The call to the method should be guarded by a check for RenderParamsFlag.FLAG_KEY_XML_FILE_PARSER_SUPPORT.

Parameters:

fileName - name of the file to parse

Returns:

the XML pull parser for the file, or null if the file with the given name does not exist

createXmlParser

@NonNull
org.xmlpull.v1.XmlPullParser createXmlParser()

Creates and returns an XmlPullParser. This method is intended for delegating calls from android.util.Xml_Delegate. It should only be used when the name of the file is not available at the point of the parser creation.

Returns:

the newly created XML parser