Class Xpp3Dom

  • All Implemented Interfaces:
    java.io.Serializable

    public class Xpp3Dom
    extends java.lang.Object
    implements java.io.Serializable
    Version:
    $Id$ NOTE: remove all the util code in here when separated, this class should be pure data.
    See Also:
    Serialized Form
    • Field Detail

      • name

        protected java.lang.String name
      • value

        protected java.lang.String value
      • attributes

        protected java.util.Map<java.lang.String,​java.lang.String> attributes
      • childList

        protected final java.util.List<Xpp3Dom> childList
      • inputLocation

        protected java.lang.Object inputLocation
        Since:
        3.2.0
      • EMPTY_STRING_ARRAY

        private static final java.lang.String[] EMPTY_STRING_ARRAY
      • EMPTY_DOM_ARRAY

        private static final Xpp3Dom[] EMPTY_DOM_ARRAY
      • 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
      • 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
    • Constructor Detail

      • Xpp3Dom

        public Xpp3Dom​(java.lang.String name)
      • Xpp3Dom

        public Xpp3Dom​(java.lang.String name,
                       java.lang.Object inputLocation)
        Since:
        3.2.0
      • Xpp3Dom

        public Xpp3Dom​(Xpp3Dom src)
        Copy constructor.
      • Xpp3Dom

        public Xpp3Dom​(Xpp3Dom src,
                       java.lang.String name)
        Copy constructor with alternative name.
    • Method Detail

      • getName

        public java.lang.String getName()
      • getValue

        public java.lang.String getValue()
      • setValue

        public void setValue​(java.lang.String value)
      • getAttributeNames

        public java.lang.String[] getAttributeNames()
      • getAttribute

        public java.lang.String getAttribute​(java.lang.String name)
      • setAttribute

        public void setAttribute​(java.lang.String name,
                                 java.lang.String value)
        Set the attribute value
        Parameters:
        name - String not null
        value - String not null
      • getChild

        public Xpp3Dom getChild​(int i)
      • getChild

        public Xpp3Dom getChild​(java.lang.String name)
      • addChild

        public void addChild​(Xpp3Dom xpp3Dom)
      • getChildren

        public Xpp3Dom[] getChildren()
      • getChildren

        public Xpp3Dom[] getChildren​(java.lang.String name)
      • getChildrenAsList

        private java.util.List<Xpp3Dom> getChildrenAsList​(java.lang.String name)
      • getChildCount

        public int getChildCount()
      • removeChild

        public void removeChild​(int i)
      • getParent

        public Xpp3Dom getParent()
      • setParent

        public void setParent​(Xpp3Dom parent)
      • getInputLocation

        public java.lang.Object getInputLocation()
        Since:
        3.2.0
      • setInputLocation

        public void setInputLocation​(java.lang.Object inputLocation)
        Since:
        3.2.0
      • writeToSerializer

        public void writeToSerializer​(java.lang.String namespace,
                                      XmlSerializer serializer)
                               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:

        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. if the dominant root node's value is empty, set it to the recessive root node's value
          2. For each attribute in the recessive root node which is not set in the dominant root node, set it.
          3. 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.
          4. 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.
      • 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 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
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • toUnescapedString

        public java.lang.String toUnescapedString()
      • isNotEmpty

        public static boolean isNotEmpty​(java.lang.String str)
      • isEmpty

        public static boolean isEmpty​(java.lang.String str)