Class Xpp3DomUtils

java.lang.Object
org.codehaus.plexus.util.xml.Xpp3DomUtils

public class Xpp3DomUtils extends Object
  • Field Details

    • CHILDREN_COMBINATION_MODE_ATTRIBUTE

      public static final String CHILDREN_COMBINATION_MODE_ATTRIBUTE
      See Also:
    • CHILDREN_COMBINATION_MERGE

      public static final String CHILDREN_COMBINATION_MERGE
      See Also:
    • CHILDREN_COMBINATION_APPEND

      public static final String CHILDREN_COMBINATION_APPEND
      See Also:
    • 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.
      See Also:
    • SELF_COMBINATION_MODE_ATTRIBUTE

      public static final String SELF_COMBINATION_MODE_ATTRIBUTE
      See Also:
    • SELF_COMBINATION_OVERRIDE

      public static final String SELF_COMBINATION_OVERRIDE
      See Also:
    • SELF_COMBINATION_MERGE

      public static final String SELF_COMBINATION_MERGE
      See Also:
    • ID_COMBINATION_MODE_ATTRIBUTE

      public static final String ID_COMBINATION_MODE_ATTRIBUTE
      In case of complex XML structures, combining can be done based on id.
      Since:
      3.0.22
      See Also:
    • KEYS_COMBINATION_MODE_ATTRIBUTE

      public static final String KEYS_COMBINATION_MODE_ATTRIBUTE
      In case of complex XML structures, combining can be done based on keys. This is a comma separated list of attribute names.
      Since:
      3.4.0
      See Also:
    • 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.
      See Also:
  • Constructor Details

    • Xpp3DomUtils

      public Xpp3DomUtils()
  • Method Details

    • writeToSerializer

      public void writeToSerializer(String namespace, XmlSerializer serializer, Xpp3Dom dom) throws IOException
      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:

      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 'combine.id' is set and there is a corresponding dominant child (matched by value of 'combine.id'), merge the two.
          2. if 'combine.keys' is set and there is a corresponding dominant child (matched by value of key elements), merge the two.
          3. if mergeChildren == true and there is a corresponding dominant child (matched by element name), merge the two.
          4. 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
      Returns:
      merged DOM
      See Also:
    • 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
      Returns:
      merged DOM
      See Also:
    • isNotEmpty

      @Deprecated public static boolean isNotEmpty(String str)
      Deprecated.
    • isEmpty

      @Deprecated public static boolean isEmpty(String str)
      Deprecated.