com.android.manifmerger

Class XmlDocument

java.lang.Object

com.android.manifmerger.XmlDocument

public class XmlDocument
extends java.lang.Object

Represents a loaded xml document. Has pointers to the root XmlElement element and provides services to persist the document to an external format. Also provides abilities to be merged with other XmlDocument as well as access to the line numbers for all document's xml elements and attributes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XmlDocument.Type The document type.

Constructor Summary

Constructors

Constructor and Description
XmlDocument(com.android.ide.common.blame.SourceFile sourceLocation, KeyResolver<java.lang.String> selectors, PlaceholderHandler.KeyBasedValueResolver<ManifestSystemProperty> systemPropertyResolver, org.w3c.dom.Element element, XmlDocument.Type type, com.google.common.base.Optional<java.lang.String> mainManifestPackageName)

Method Summary

Modifier and Type	Method and Description
void	clearNodeNamespaces() Removes the android namespace from all nodes.
com.google.common.base.Optional<java.lang.String>	compareTo(XmlDocument other) Compares this document to another XmlDocument ignoring all attributes belonging to the SdkConstants.TOOLS_URI namespace.
com.google.common.base.Optional<XmlElement>	getByTypeAndKey(com.android.manifmerger.ManifestModel.NodeTypes type, java.lang.String keyValue)
XmlDocument.Type	getFileType()
com.google.common.base.Optional<XmlAttribute>	getPackage()
java.lang.String	getPackageName() Package name for this android manifest which will be used to resolve partial path.
java.lang.String	getPackageNameForAttributeExpansion() Returns the package name to use to expand the attributes values with the document's package name
XmlElement	getRootNode()
KeyResolver<java.lang.String>	getSelectors() Returns a KeyResolver capable of resolving all selectors types
com.android.ide.common.blame.SourceFile	getSourceFile() Returns the SourceFile associated with this XML document.
java.lang.String	getSplitName() Returns the split name if this manifest file has one.
PlaceholderHandler.KeyBasedValueResolver<ManifestSystemProperty>	getSystemPropertyResolver() Returns the PlaceholderHandler.KeyBasedValueResolver capable of resolving all injected ManifestSystemProperty
org.w3c.dom.Document	getXml()
com.google.common.base.Optional<XmlDocument>	merge(XmlDocument lowerPriorityDocument, com.android.manifmerger.MergingReport.Builder mergingReportBuilder) merge this higher priority document with a higher priority document.
com.google.common.base.Optional<XmlDocument>	merge(XmlDocument lowerPriorityDocument, com.android.manifmerger.MergingReport.Builder mergingReportBuilder, boolean addImplicitPermissions) merge this higher priority document with a higher priority document.
java.lang.String	prettyPrint() Returns a pretty string representation of this document.
XmlDocument	reparse() Forces a re-parsing of the document

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlDocument

public XmlDocument(@NonNull
                   com.android.ide.common.blame.SourceFile sourceLocation,
                   @NonNull
                   KeyResolver<java.lang.String> selectors,
                   @NonNull
                   PlaceholderHandler.KeyBasedValueResolver<ManifestSystemProperty> systemPropertyResolver,
                   @NonNull
                   org.w3c.dom.Element element,
                   @NonNull
                   XmlDocument.Type type,
                   @NonNull
                   com.google.common.base.Optional<java.lang.String> mainManifestPackageName)

Method Detail

getFileType

@NonNull
public XmlDocument.Type getFileType()

prettyPrint

@NonNull
public java.lang.String prettyPrint()

Returns a pretty string representation of this document.

merge

@NonNull
public com.google.common.base.Optional<XmlDocument> merge(@NonNull
                                                                   XmlDocument lowerPriorityDocument,
                                                                   @NonNull
                                                                   com.android.manifmerger.MergingReport.Builder mergingReportBuilder)

merge this higher priority document with a higher priority document.

Parameters:

lowerPriorityDocument - the lower priority document to merge in.

mergingReportBuilder - the merging report to record errors and actions.

Returns:

a new merged XmlDocument or Optional.absent() if there were errors during the merging activities.

merge

@NonNull
public com.google.common.base.Optional<XmlDocument> merge(@NonNull
                                                                   XmlDocument lowerPriorityDocument,
                                                                   @NonNull
                                                                   com.android.manifmerger.MergingReport.Builder mergingReportBuilder,
                                                                   boolean addImplicitPermissions)

merge this higher priority document with a higher priority document.

Parameters:

lowerPriorityDocument - the lower priority document to merge in.

mergingReportBuilder - the merging report to record errors and actions.

addImplicitPermissions - whether to perform implicit permission addition.

Returns:

a new merged XmlDocument or Optional.absent() if there were errors during the merging activities.

reparse

@NonNull
public XmlDocument reparse()

Forces a re-parsing of the document

Returns:

a new XmlDocument with up to date information.

getSelectors

@NonNull
public KeyResolver<java.lang.String> getSelectors()

Returns a KeyResolver capable of resolving all selectors types

getSystemPropertyResolver

@NonNull
public PlaceholderHandler.KeyBasedValueResolver<ManifestSystemProperty> getSystemPropertyResolver()

Returns the PlaceholderHandler.KeyBasedValueResolver capable of resolving all injected ManifestSystemProperty

compareTo

public com.google.common.base.Optional<java.lang.String> compareTo(@NonNull
                                                                   XmlDocument other)

Compares this document to another XmlDocument ignoring all attributes belonging to the SdkConstants.TOOLS_URI namespace.

Parameters:

other - the other document to compare against.

Returns:

a String describing the differences between the two XML elements or Optional.absent() if they are equals.

getSourceFile

@NonNull
public com.android.ide.common.blame.SourceFile getSourceFile()

Returns the SourceFile associated with this XML document.

NOTE: You should not read the contents of the file directly; if you need to access the content, use ManifestMerger2.getFileStreamProvider() instead.

Returns:

the source file

getRootNode

public XmlElement getRootNode()

getByTypeAndKey

public com.google.common.base.Optional<XmlElement> getByTypeAndKey(com.android.manifmerger.ManifestModel.NodeTypes type,
                                                                   @Nullable
                                                                   java.lang.String keyValue)

getPackageName

public java.lang.String getPackageName()

Package name for this android manifest which will be used to resolve partial path. In the case of Overlays, this is absent and the main manifest packageName must be used.

Returns:

the package name to do partial class names resolution.

getSplitName

public java.lang.String getSplitName()

Returns the split name if this manifest file has one.

Returns:

the split name or empty string.

getPackageNameForAttributeExpansion

public java.lang.String getPackageNameForAttributeExpansion()

Returns the package name to use to expand the attributes values with the document's package name

Returns:

the package name to use for attribute expansion.

getPackage

public com.google.common.base.Optional<XmlAttribute> getPackage()

getXml

public org.w3c.dom.Document getXml()

clearNodeNamespaces

public void clearNodeNamespaces()

Removes the android namespace from all nodes.