Package org.codehaus.plexus.util.xml
Class Xpp3Dom
java.lang.Object
org.codehaus.plexus.util.xml.Xpp3Dom
- All Implemented Interfaces:
Serializable
- Version:
- $Id$ NOTE: remove all the util code in here when separated, this class should be pure data.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final StringThis 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 final StringThis 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.private static final Xpp3Dom[]private static final String[]protected Objectprotected Stringprotected Xpp3Domstatic final Stringstatic final Stringstatic final Stringprivate static final longprotected String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidbooleangetAttribute(String name) String[]getChild(int i) intXpp3Dom[]Xpp3Dom[]getChildren(String name) getChildrenAsList(String name) getName()getValue()inthashCode()static booleanstatic booleanisNotEmpty(String str) private 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) Merge two DOMs, with one having dominance in the case of collision.static Xpp3DommergeXpp3Dom(Xpp3Dom dominant, Xpp3Dom recessive, Boolean childMergeOverride) Merge two DOMs, with one having dominance in the case of collision.voidremoveChild(int i) voidsetAttribute(String name, String value) Set the attribute valuevoidsetInputLocation(Object inputLocation) voidvoidtoString()voidwriteToSerializer(String namespace, XmlSerializer serializer)
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
name
-
value
-
attributes
-
childList
-
parent
-
inputLocation
- Since:
- 3.2.0
-
EMPTY_STRING_ARRAY
-
EMPTY_DOM_ARRAY
-
CHILDREN_COMBINATION_MODE_ATTRIBUTE
- See Also:
-
CHILDREN_COMBINATION_MERGE
- See Also:
-
CHILDREN_COMBINATION_APPEND
- See Also:
-
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.- See Also:
-
SELF_COMBINATION_MODE_ATTRIBUTE
- See Also:
-
SELF_COMBINATION_OVERRIDE
- See Also:
-
SELF_COMBINATION_MERGE
- See Also:
-
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.- See Also:
-
-
Constructor Details
-
Xpp3Dom
-
Xpp3Dom
- Since:
- 3.2.0
-
Xpp3Dom
Copy constructor. -
Xpp3Dom
Copy constructor with alternative name.
-
-
Method Details
-
getName
-
getValue
-
setValue
-
getAttributeNames
-
getAttribute
-
setAttribute
Set the attribute value- Parameters:
name- String not nullvalue- String not null
-
getChild
-
getChild
-
addChild
-
getChildren
-
getChildren
-
getChildrenAsList
-
getChildCount
public int getChildCount() -
removeChild
public void removeChild(int i) -
getParent
-
setParent
-
getInputLocation
- Since:
- 3.2.0
-
setInputLocation
- Since:
- 3.2.0
-
writeToSerializer
- Throws:
IOException
-
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:
- if the recessive DOM is null, there is nothing to do... return.
- Determine whether the dominant node will suppress the recessive one (flag=mergeSelf).
- 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.
- 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.
- If mergeSelf == true
- if the dominant root node's value is empty, set it to the recessive root node's value
- For each attribute in the recessive root node which is not set in the dominant root node, set it.
- Determine whether children from the recessive DOM will be merged or appended to the dominant DOM as
siblings (flag=mergeChildren).
- if childMergeOverride is set (non-null), use that value (true/false)
- 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.
- 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.
- Iterate through the recessive children, and:
- if mergeChildren == true and there is a corresponding dominant child (matched by element name), merge the two.
- otherwise, add the recessive child as a new child on the dominant root node.
-
mergeXpp3Dom
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 mergedrecessive- The recessive DOM, which will be merged into the dominant DOMchildMergeOverride- Overrides attribute flags to force merging or appending of child elements into the dominant DOM- See Also:
-
mergeXpp3Dom
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 mergedrecessive- The recessive DOM, which will be merged into the dominant DOM- See Also:
-
equals
-
hashCode
public int hashCode() -
toString
-
toUnescapedString
-
isNotEmpty
-
isEmpty
-