Package org.codehaus.plexus.util.xml
Class Xpp3DomUtils
- java.lang.Object
-
- org.codehaus.plexus.util.xml.Xpp3DomUtils
-
public class Xpp3DomUtils extends java.lang.Object
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CHILDREN_COMBINATION_APPEND
static java.lang.String
CHILDREN_COMBINATION_MERGE
static java.lang.String
CHILDREN_COMBINATION_MODE_ATTRIBUTE
static java.lang.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.static java.lang.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.static java.lang.String
ID_COMBINATION_MODE_ATTRIBUTE
In case of complex XML structures, combining can be done based on id.static java.lang.String
SELF_COMBINATION_MERGE
static java.lang.String
SELF_COMBINATION_MODE_ATTRIBUTE
static java.lang.String
SELF_COMBINATION_OVERRIDE
-
Constructor Summary
Constructors Constructor Description Xpp3DomUtils()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static boolean
isEmpty(java.lang.String str)
static boolean
isNotEmpty(java.lang.String str)
private static void
mergeIntoXpp3Dom(Xpp3Dom dominant, Xpp3Dom recessive, java.lang.Boolean childMergeOverride)
Merges one DOM into another, given a specific algorithm and possible override points for that algorithm.static Xpp3Dom
mergeXpp3Dom(Xpp3Dom dominant, Xpp3Dom recessive)
Merge two DOMs, with one having dominance in the case of collision.static Xpp3Dom
mergeXpp3Dom(Xpp3Dom dominant, Xpp3Dom recessive, java.lang.Boolean childMergeOverride)
Merge two DOMs, with one having dominance in the case of collision.void
writeToSerializer(java.lang.String namespace, XmlSerializer serializer, Xpp3Dom dom)
-
-
-
Field Detail
-
CHILDREN_COMBINATION_MODE_ATTRIBUTE
public static final java.lang.String CHILDREN_COMBINATION_MODE_ATTRIBUTE
- See Also:
- Constant Field Values
-
CHILDREN_COMBINATION_MERGE
public static final java.lang.String CHILDREN_COMBINATION_MERGE
- See Also:
- Constant Field Values
-
CHILDREN_COMBINATION_APPEND
public static final java.lang.String CHILDREN_COMBINATION_APPEND
- See Also:
- Constant Field Values
-
DEFAULT_CHILDREN_COMBINATION_MODE
public static final java.lang.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.- See Also:
- Constant Field Values
-
SELF_COMBINATION_MODE_ATTRIBUTE
public static final java.lang.String SELF_COMBINATION_MODE_ATTRIBUTE
- See Also:
- Constant Field Values
-
SELF_COMBINATION_OVERRIDE
public static final java.lang.String SELF_COMBINATION_OVERRIDE
- See Also:
- Constant Field Values
-
SELF_COMBINATION_MERGE
public static final java.lang.String SELF_COMBINATION_MERGE
- See Also:
- Constant Field Values
-
ID_COMBINATION_MODE_ATTRIBUTE
public static final java.lang.String ID_COMBINATION_MODE_ATTRIBUTE
In case of complex XML structures, combining can be done based on id.- Since:
- 3.0.22
- See Also:
- Constant Field Values
-
DEFAULT_SELF_COMBINATION_MODE
public static final java.lang.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.- See Also:
- Constant Field Values
-
-
Method Detail
-
writeToSerializer
public void writeToSerializer(java.lang.String namespace, XmlSerializer serializer, Xpp3Dom dom) throws java.io.IOException
- Throws:
java.io.IOException
-
mergeIntoXpp3Dom
private static void mergeIntoXpp3Dom(Xpp3Dom dominant, Xpp3Dom recessive, java.lang.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 'combine.id' is set and there is a corresponding dominant child (matched by value of 'combine.id'), merge the two.
- 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
public static Xpp3Dom mergeXpp3Dom(Xpp3Dom dominant, Xpp3Dom recessive, java.lang.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 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:
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 mergedrecessive
- The recessive DOM, which will be merged into the dominant DOM- See Also:
CHILDREN_COMBINATION_MODE_ATTRIBUTE
,SELF_COMBINATION_MODE_ATTRIBUTE
-
isNotEmpty
public static boolean isNotEmpty(java.lang.String str)
-
isEmpty
public static boolean isEmpty(java.lang.String str)
-
-