com.android.manifmerger

Class XmlNode

java.lang.Object

com.android.manifmerger.XmlNode

Direct Known Subclasses:

OrphanXmlElement, XmlAttribute

public abstract class XmlNode
extends java.lang.Object

Common behavior of any xml declaration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XmlNode.Name Implementation of XmlNode.NodeName for an node's declaration not using a namespace.
static class	XmlNode.NamespaceAwareName Implementation of the XmlNode.NodeName for a namespace aware attribute.
static class	XmlNode.NodeKey A xml element or attribute key.
static interface	XmlNode.NodeName Abstraction to an xml name to isolate whether the name has a namespace or not.

Field Summary

Fields

Modifier and Type	Field and Description
protected static com.google.common.base.Function<org.w3c.dom.Node,java.lang.String>	NODE_TO_NAME

Constructor Summary

Constructors

Constructor and Description
XmlNode()

Method Summary

Modifier and Type	Method and Description
static XmlNode.NodeName	fromNSName(java.lang.String namespaceUri, java.lang.String prefix, java.lang.String localName)
static XmlNode.NodeName	fromXmlName(java.lang.String name)
abstract XmlNode.NodeKey	getId() Returns an unique id within the manifest file for the element.
abstract XmlNode.NodeName	getName() Returns the name of this xml element or attribute.
XmlNode.NodeKey	getOriginalId() Returns a constant Nodekey that can be used throughout the lifecycle of the xml element.
abstract com.android.ide.common.blame.SourcePosition	getPosition() Returns the element's position
abstract com.android.ide.common.blame.SourceFile	getSourceFile() Returns the element's document xml source file location.
com.android.ide.common.blame.SourceFilePosition	getSourceFilePosition() Returns the element's document xml source file location.
abstract org.w3c.dom.Node	getXml() Returns the element's xml
java.lang.String	printPosition() Returns the position of this attribute in the original xml file.
static XmlNode.NodeName	unwrapName(org.w3c.dom.Node node) Factory method to create an instance of XmlNode.NodeName for an existing xml node.

Methods inherited from class java.lang.Object

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

Field Detail

NODE_TO_NAME

protected static final com.google.common.base.Function<org.w3c.dom.Node,java.lang.String> NODE_TO_NAME

Constructor Detail

XmlNode

public XmlNode()

Method Detail

getOriginalId

@NonNull
public XmlNode.NodeKey getOriginalId()

Returns a constant Nodekey that can be used throughout the lifecycle of the xml element. The getId() can return different values over time as the key of the element can be for instance, changed through placeholder replacement.

getId

@NonNull
public abstract XmlNode.NodeKey getId()

Returns an unique id within the manifest file for the element.

getPosition

@NonNull
public abstract com.android.ide.common.blame.SourcePosition getPosition()

Returns the element's position

getSourceFile

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

Returns the element's document xml source file location.

getSourceFilePosition

@NonNull
public com.android.ide.common.blame.SourceFilePosition getSourceFilePosition()

Returns the element's document xml source file location.

getXml

@NonNull
public abstract org.w3c.dom.Node getXml()

Returns the element's xml

getName

@NonNull
public abstract XmlNode.NodeName getName()

Returns the name of this xml element or attribute.

unwrapName

@NonNull
public static XmlNode.NodeName unwrapName(@NonNull
                                                   org.w3c.dom.Node node)

Factory method to create an instance of XmlNode.NodeName for an existing xml node.

Parameters:

node - the xml definition.

Returns:

an instance of XmlNode.NodeName providing namespace handling.

fromXmlName

@NonNull
public static XmlNode.NodeName fromXmlName(@NonNull
                                                    java.lang.String name)

fromNSName

@NonNull
public static XmlNode.NodeName fromNSName(@NonNull
                                                   java.lang.String namespaceUri,
                                                   @NonNull
                                                   java.lang.String prefix,
                                                   @NonNull
                                                   java.lang.String localName)

printPosition

@NonNull
public java.lang.String printPosition()

Returns the position of this attribute in the original xml file. This may return an invalid location as this xml fragment does not exist in any xml file but is the temporary result of the merging process.

Returns:

a human readable position.