Xpp3Dom (Maven XML Implementation 4.0.0-alpha-2 API)

java.lang.Object
- org.apache.maven.internal.xml.Xpp3Dom

All Implemented Interfaces:

Serializable, Dom
```
public class Xpp3Dom
extends Object
implements Serializable, Dom
```
NOTE: remove all the util code in here when separated, this class should be pure data.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,String>`	`attributes`
`protected List<Dom>`	`children`
`protected Object`	`location`
`protected String`	`name`
`protected String`	`value`

Fields inherited from interface org.apache.maven.api.xml.Dom
CHILDREN_COMBINATION_APPEND, CHILDREN_COMBINATION_MERGE, CHILDREN_COMBINATION_MODE_ATTRIBUTE, DEFAULT_CHILDREN_COMBINATION_MODE, DEFAULT_SELF_COMBINATION_MODE, SELF_COMBINATION_MERGE, SELF_COMBINATION_MODE_ATTRIBUTE, SELF_COMBINATION_OVERRIDE, SELF_COMBINATION_REMOVE

Constructor Summary

Constructors
Constructor and Description
`Xpp3Dom(Dom from, String name)`
`Xpp3Dom(String name)`
`Xpp3Dom(String name, String value)`
`Xpp3Dom(String name, String value, Map<String,String> attributes, List<Dom> children, Object location)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Dom`	`clone()`
`boolean`	`equals(Object o)`
`String`	`getAttribute(String name)`
`Map<String,String>`	`getAttributes()`
`Dom`	`getChild(String name)`
`int`	`getChildCount()`
`List<Dom>`	`getChildren()`
`Object`	`getInputLocation()`
`String`	`getName()`
`String`	`getValue()`
`int`	`hashCode()`
`static boolean`	`isEmpty(String str)`
`static boolean`	`isNotEmpty(String str)`
`Dom`	`merge(Dom source, Boolean childMergeOverride)`
`static Dom`	`merge(Dom dominant, Dom recessive)` Merge two DOMs, with one having dominance in the case of collision.
`static Dom`	`merge(Dom dominant, Dom recessive, Boolean childMergeOverride)` Merges one DOM into another, given a specific algorithm and possible override points for that algorithm.
`String`	`toString()`
`String`	`toUnescapedString()`
`void`	`writeToSerializer(String namespace, org.codehaus.plexus.util.xml.pull.XmlSerializer serializer)`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.maven.api.xml.Dom
merge

- Field Detail
  - name
```
protected final String name
```
  - value
```
protected final String value
```
  - attributes
```
protected final Map<String,String> attributes
```
  - children
```
protected final List<Dom> children
```
  - location
```
protected final Object location
```
- Constructor Detail
  - Xpp3Dom
```
public Xpp3Dom(String name)
```
  - Xpp3Dom
```
public Xpp3Dom(String name,
               String value)
```
  - Xpp3Dom
```
public Xpp3Dom(Dom from,
               String name)
```
  - Xpp3Dom
```
public Xpp3Dom(String name,
               String value,
               Map<String,String> attributes,
               List<Dom> children,
               Object location)
```
- Method Detail
  - merge
```
public Dom merge(Dom source,
                 Boolean childMergeOverride)
```
    Specified by:
    
    merge in interface Dom
  - clone
```
public Dom clone()
```
    Specified by:
    
    clone in interface Dom
    
    Overrides:
    
    clone in class Object
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface Dom
  - getValue
```
public String getValue()
```
    Specified by:
    
    getValue in interface Dom
  - getAttributes
```
public Map<String,String> getAttributes()
```
    Specified by:
    
    getAttributes in interface Dom
  - getAttribute
```
public String getAttribute(String name)
```
    Specified by:
    
    getAttribute in interface Dom
  - getChild
```
public Dom getChild(String name)
```
    Specified by:
    
    getChild in interface Dom
  - getChildren
```
public List<Dom> getChildren()
```
    Specified by:
    
    getChildren in interface Dom
  - getChildCount
```
public int getChildCount()
```
  - getInputLocation
```
public Object getInputLocation()
```
    Specified by:
    
    getInputLocation in interface Dom
    
    Returns:
    
    input location
    
    Since:
    
    3.2.0
  - writeToSerializer
```
public void writeToSerializer(String namespace,
                              org.codehaus.plexus.util.xml.pull.XmlSerializer serializer)
                       throws IOException
```
    Throws:
    
    IOException
  - merge
```
public static Dom merge(Dom dominant,
                        Dom 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).
      
      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.
    3. 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.
    Specified by:
    
    merge in interface Dom
  - merge
```
public static Dom merge(Dom dominant,
                        Dom 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.
    
    Specified by:
    
    merge in interface Dom
    
    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:
    
    Dom.CHILDREN_COMBINATION_MODE_ATTRIBUTE, Dom.SELF_COMBINATION_MODE_ATTRIBUTE
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toUnescapedString
```
public String toUnescapedString()
```
  - isNotEmpty
```
public static boolean isNotEmpty(String str)
```
  - isEmpty
```
public static boolean isEmpty(String str)
```

Class Xpp3Dom

Field Summary

Fields inherited from interface org.apache.maven.api.xml.Dom

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.maven.api.xml.Dom

Field Detail

name

value

attributes

children

location

Constructor Detail

Xpp3Dom

Xpp3Dom

Xpp3Dom

Xpp3Dom

Method Detail

merge

clone

getName

getValue

getAttributes

getAttribute

getChild

getChildren

getChildCount

getInputLocation

writeToSerializer

merge

merge

equals

hashCode

toString

toUnescapedString

isNotEmpty

isEmpty