org.codehaus.plexus.util.xml

Class Xpp3Dom

public class Xpp3Dom extends Object

Field Summary
protected Mapattributes
protected ListchildList
protected MapchildMap
static StringCHILDREN_COMBINATION_APPEND
static StringCHILDREN_COMBINATION_MERGE
static StringCHILDREN_COMBINATION_MODE_ATTRIBUTE
static StringDEFAULT_CHILDREN_COMBINATION_MODE
This default mode for combining children DOMs during merge means that where element names match, the process will try to merge the element data, rather than putting the dominant and recessive elements (which share the same element name) as siblings in the resulting DOM.
static StringDEFAULT_SELF_COMBINATION_MODE
This default mode for combining a DOM node during merge means that where element names match, the process will try to merge the element attributes and values, rather than overriding the recessive element completely with the dominant one.
static Xpp3Dom[]EMPTY_DOM_ARRAY
protected Stringname
protected Xpp3Domparent
static StringSELF_COMBINATION_MERGE
static StringSELF_COMBINATION_MODE_ATTRIBUTE
static StringSELF_COMBINATION_OVERRIDE
protected Stringvalue
Constructor Summary
Xpp3Dom(String name)
Xpp3Dom(Xpp3Dom src)
Method Summary
voidaddChild(Xpp3Dom xpp3Dom)
booleanequals(Object obj)
StringgetAttribute(String name)
String[]getAttributeNames()
Xpp3DomgetChild(int i)
Xpp3DomgetChild(String name)
intgetChildCount()
Xpp3Dom[]getChildren()
Xpp3Dom[]getChildren(String name)
StringgetName()
Xpp3DomgetParent()
StringgetValue()
inthashCode()
static voidmergeIntoXpp3Dom(Xpp3Dom dominant, Xpp3Dom recessive, Boolean childMergeOverride)
Merges one DOM into another, given a specific algorithm and possible override points for that algorithm.
static Xpp3DommergeXpp3Dom(Xpp3Dom dominant, Xpp3Dom recessive, Boolean childMergeOverride)
Merge two DOMs, with one having dominance in the case of collision.
static Xpp3DommergeXpp3Dom(Xpp3Dom dominant, Xpp3Dom recessive)
Merge two DOMs, with one having dominance in the case of collision.
voidremoveChild(int i)
voidsetAttribute(String name, String value)
Set the attribute value
voidsetParent(Xpp3Dom parent)
voidsetValue(String value)
StringtoString()
StringtoUnescapedString()
voidwriteToSerializer(String namespace, XmlSerializer serializer)

Field Detail

attributes

protected Map attributes

childList

protected List childList

childMap

protected Map childMap

CHILDREN_COMBINATION_APPEND

public static final String CHILDREN_COMBINATION_APPEND

CHILDREN_COMBINATION_MERGE

public static final String CHILDREN_COMBINATION_MERGE

CHILDREN_COMBINATION_MODE_ATTRIBUTE

public static final String CHILDREN_COMBINATION_MODE_ATTRIBUTE

DEFAULT_CHILDREN_COMBINATION_MODE

public static final String DEFAULT_CHILDREN_COMBINATION_MODE
This default mode for combining children DOMs during merge means that where element names match, the process will try to merge the element data, rather than putting the dominant and recessive elements (which share the same element name) as siblings in the resulting DOM.

DEFAULT_SELF_COMBINATION_MODE

public static final String DEFAULT_SELF_COMBINATION_MODE
This default mode for combining a DOM node during merge means that where element names match, the process will try to merge the element attributes and values, rather than overriding the recessive element completely with the dominant one. This means that wherever the dominant element doesn't provide the value or a particular attribute, that value or attribute will be set from the recessive DOM node.

EMPTY_DOM_ARRAY

private static final Xpp3Dom[] EMPTY_DOM_ARRAY

name

protected String name

parent

protected Xpp3Dom parent

SELF_COMBINATION_MERGE

public static final String SELF_COMBINATION_MERGE

SELF_COMBINATION_MODE_ATTRIBUTE

public static final String SELF_COMBINATION_MODE_ATTRIBUTE

SELF_COMBINATION_OVERRIDE

public static final String SELF_COMBINATION_OVERRIDE

value

protected String value

Constructor Detail

Xpp3Dom

public Xpp3Dom(String name)

Xpp3Dom

public Xpp3Dom(Xpp3Dom src)

Method Detail

addChild

public void addChild(Xpp3Dom xpp3Dom)

equals

public boolean equals(Object obj)

getAttribute

public String getAttribute(String name)

getAttributeNames

public String[] getAttributeNames()

getChild

public Xpp3Dom getChild(int i)

getChild

public Xpp3Dom getChild(String name)

getChildCount

public int getChildCount()

getChildren

public Xpp3Dom[] getChildren()

getChildren

public Xpp3Dom[] getChildren(String name)

getName

public String getName()

getParent

public Xpp3Dom getParent()

getValue

public String getValue()

hashCode

public int hashCode()

mergeIntoXpp3Dom

private static void mergeIntoXpp3Dom(Xpp3Dom dominant, Xpp3Dom 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). A. 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. B. 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 A. if the dominant root node's value is empty, set it to the recessive root node's value B. For each attribute in the recessive root node which is not set in the dominant root node, set it. C. Determine whether children from the recessive DOM will be merged or appended to the dominant DOM as siblings (flag=mergeChildren). i. if childMergeOverride is set (non-null), use that value (true/false) ii. retrieve the 'combine.children' attribute on the dominant node, and try to match against 'append'...if it matches 'append', then set mergeChildren == false...the recessive children will be appended as siblings of the dominant children. iii. 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. D. Iterate through the recessive children, and: i. if mergeChildren == true and there is a corresponding dominant child (matched by element name), merge the two. ii. otherwise, add the recessive child as a new child on the dominant root node.

mergeXpp3Dom

public static Xpp3Dom mergeXpp3Dom(Xpp3Dom dominant, Xpp3Dom recessive, Boolean childMergeOverride)
Merge two DOMs, with one having dominance in the case of collision.

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 childMergeOverride Overrides attribute flags to force merging or appending of child elements into the dominant DOM

See Also: CHILDREN_COMBINATION_MODE_ATTRIBUTE SELF_COMBINATION_MODE_ATTRIBUTE

mergeXpp3Dom

public static Xpp3Dom mergeXpp3Dom(Xpp3Dom dominant, Xpp3Dom 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

See Also: CHILDREN_COMBINATION_MODE_ATTRIBUTE SELF_COMBINATION_MODE_ATTRIBUTE

removeChild

public void removeChild(int i)

setAttribute

public void setAttribute(String name, String value)
Set the attribute value

Parameters: name String not null value String not null

setParent

public void setParent(Xpp3Dom parent)

setValue

public void setValue(String value)

toString

public String toString()

toUnescapedString

public String toUnescapedString()

writeToSerializer

public void writeToSerializer(String namespace, XmlSerializer serializer)