Package org.apache.maven.internal.xml

Class XmlNodeImpl

java.lang.Object

org.apache.maven.internal.xml.XmlNodeImpl

All Implemented Interfaces:

Serializable, XmlNode

public class XmlNodeImpl
extends Object
implements Serializable, XmlNode

NOTE: remove all the util code in here when separated, this class should be pure data.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,String>	attributes
protected final List<XmlNode>	children
protected final Object	location
protected final String	name
protected final String	value

Fields inherited from interface org.apache.maven.api.xml.XmlNode

CHILDREN_COMBINATION_APPEND, CHILDREN_COMBINATION_MERGE, CHILDREN_COMBINATION_MODE_ATTRIBUTE, DEFAULT_CHILDREN_COMBINATION_MODE, DEFAULT_SELF_COMBINATION_MODE, ID_COMBINATION_MODE_ATTRIBUTE, KEYS_COMBINATION_MODE_ATTRIBUTE, SELF_COMBINATION_MERGE, SELF_COMBINATION_MODE_ATTRIBUTE, SELF_COMBINATION_OVERRIDE, SELF_COMBINATION_REMOVE

Constructor Summary

Constructors

Constructor	Description
XmlNodeImpl(String name)
XmlNodeImpl(String name, String value)
XmlNodeImpl(String name, String value, Map<String,String> attributes, List<XmlNode> children, Object location)
XmlNodeImpl(XmlNode from, String name)

Method Summary

Modifier and Type	Method	Description
XmlNode	clone()
boolean	equals(Object o)
String	getAttribute(String name)
Map<String,String>	getAttributes()
XmlNode	getChild(String name)
int	getChildCount()
List<XmlNode>	getChildren()
Object	getInputLocation()
String	getName()
String	getValue()
int	hashCode()
XmlNode	merge(XmlNode source, Boolean childMergeOverride)
static XmlNode	merge(XmlNode dominant, XmlNode recessive)	Merge two DOMs, with one having dominance in the case of collision.
static XmlNode	merge(XmlNode dominant, XmlNode recessive, Boolean childMergeOverride)	Merges one DOM into another, given a specific algorithm and possible override points for that algorithm.
String	toString()
String	toUnescapedString()
void	writeToSerializer(String namespace, org.codehaus.plexus.util.xml.pull.XmlSerializer serializer)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.maven.api.xml.XmlNode

merge

Field Details

name

protected final String name

value

protected final String value

attributes

protected final Map<String,String> attributes

children

protected final List<XmlNode> children

location

protected final Object location

Constructor Details

XmlNodeImpl

public XmlNodeImpl(String name)

XmlNodeImpl

public XmlNodeImpl(String name,
 String value)

XmlNodeImpl

public XmlNodeImpl(XmlNode from,
 String name)

XmlNodeImpl

public XmlNodeImpl(String name,
 String value,
 Map<String,String> attributes,
 List<XmlNode> children,
 Object location)

Method Details

merge

public XmlNode merge(XmlNode source,
 Boolean childMergeOverride)

Specified by:

merge in interface XmlNode

clone

public XmlNode clone()

Specified by:

clone in interface XmlNode

Overrides:

clone in class Object

getName

public String getName()

Specified by:

getName in interface XmlNode

getValue

public String getValue()

Specified by:

getValue in interface XmlNode

getAttributes

public Map<String,String> getAttributes()

Specified by:

getAttributes in interface XmlNode

getAttribute

public String getAttribute(String name)

Specified by:

getAttribute in interface XmlNode

getChild

public XmlNode getChild(String name)

Specified by:

getChild in interface XmlNode

getChildren

public List<XmlNode> getChildren()

Specified by:

getChildren in interface XmlNode

getChildCount

public int getChildCount()

getInputLocation

public Object getInputLocation()

Specified by:

getInputLocation in interface XmlNode

Returns:

input location

Since:

3.2.0

writeToSerializer

public void writeToSerializer(String namespace,
 org.codehaus.plexus.util.xml.pull.XmlSerializer serializer)
                       throws IOException

Throws:

IOException

merge

public static XmlNode merge(XmlNode dominant,
 XmlNode recessive,
 Boolean childMergeOverride)

Merges one DOM into another, given a specific algorithm and possible override points for that algorithm.

The algorithm is as follows:

1. if the recessive DOM is null, there is nothing to do... return.
2. Determine whether the dominant node will suppress the recessive one (flag=mergeSelf).
   1. retrieve the 'combine.self' attribute on the dominant node, and try to match against 'override'... if it matches 'override', then set mergeSelf == false...the dominant node suppresses the recessive one completely.
   2. otherwise, use the default value for mergeSelf, which is true...this is the same as specifying 'combine.self' == 'merge' as an attribute of the dominant root node.
3. If mergeSelf == true
   1. Determine whether children from the recessive DOM will be merged or appended to the dominant DOM as siblings (flag=mergeChildren).
      1. if childMergeOverride is set (non-null), use that value (true/false)
      2. retrieve the 'combine.children' attribute on the dominant node, and try to match against 'append'...
      3. if it matches 'append', then set mergeChildren == false...the recessive children will be appended as siblings of the dominant children.
      4. otherwise, use the default value for mergeChildren, which is true...this is the same as specifying 'combine.children' == 'merge' as an attribute on the dominant root node.
   2. Iterate through the recessive children, and:
      1. if mergeChildren == true and there is a corresponding dominant child (matched by element name), merge the two.
      2. otherwise, add the recessive child as a new child on the dominant root node.

merge

public static XmlNode merge(XmlNode dominant,
 XmlNode recessive)

Merge two DOMs, with one having dominance in the case of collision. Merge mechanisms (vs. override for nodes, or vs. append for children) is determined by attributes of the dominant root node.

Parameters:

dominant - The dominant DOM into which the recessive value/attributes/children will be merged

recessive - The recessive DOM, which will be merged into the dominant DOM

Returns:

merged DOM

See Also:

• XmlNode.CHILDREN_COMBINATION_MODE_ATTRIBUTE
• XmlNode.SELF_COMBINATION_MODE_ATTRIBUTE

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toUnescapedString

public String toUnescapedString()