Xpp3Dom (Plexus Common Utilities 3.2.0 API)

java.lang.Object
- org.codehaus.plexus.util.xml.Xpp3Dom

All Implemented Interfaces:

Serializable
```
public class Xpp3Dom
extends Object
implements Serializable
```
Version:

$Id$ 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<Xpp3Dom>`	`childList`
`protected Map<String,Xpp3Dom>`	`childMap`
`static String`	`CHILDREN_COMBINATION_APPEND`
`static String`	`CHILDREN_COMBINATION_MERGE`
`static String`	`CHILDREN_COMBINATION_MODE_ATTRIBUTE`
`static 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 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.
`protected Object`	`inputLocation`
`protected String`	`name`
`protected Xpp3Dom`	`parent`
`static String`	`SELF_COMBINATION_MERGE`
`static String`	`SELF_COMBINATION_MODE_ATTRIBUTE`
`static String`	`SELF_COMBINATION_OVERRIDE`
`protected String`	`value`

Constructor Summary

Constructors
Constructor and Description
`Xpp3Dom(String name)`
`Xpp3Dom(String name, Object inputLocation)`
`Xpp3Dom(Xpp3Dom src)` Copy constructor.
`Xpp3Dom(Xpp3Dom src, String name)` Copy constructor with alternative name.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addChild(Xpp3Dom xpp3Dom)`
`boolean`	`equals(Object obj)`
`String`	`getAttribute(String name)`
`String[]`	`getAttributeNames()`
`Xpp3Dom`	`getChild(int i)`
`Xpp3Dom`	`getChild(String name)`
`int`	`getChildCount()`
`Xpp3Dom[]`	`getChildren()`
`Xpp3Dom[]`	`getChildren(String name)`
`Object`	`getInputLocation()`
`String`	`getName()`
`Xpp3Dom`	`getParent()`
`String`	`getValue()`
`int`	`hashCode()`
`static boolean`	`isEmpty(String str)`
`static boolean`	`isNotEmpty(String str)`
`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, Boolean childMergeOverride)` Merge two DOMs, with one having dominance in the case of collision.
`void`	`removeChild(int i)`
`void`	`setAttribute(String name, String value)` Set the attribute value
`void`	`setInputLocation(Object inputLocation)`
`void`	`setParent(Xpp3Dom parent)`
`void`	`setValue(String value)`
`String`	`toString()`
`String`	`toUnescapedString()`
`void`	`writeToSerializer(String namespace, XmlSerializer serializer)`

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

- Field Detail
  - name
```
protected String name
```
  - value
```
protected String value
```
  - attributes
```
protected Map<String,String> attributes
```
  - childList
```
protected final List<Xpp3Dom> childList
```
  - childMap
```
protected final Map<String,Xpp3Dom> childMap
```
  - parent
```
protected Xpp3Dom parent
```
  - inputLocation
```
protected Object inputLocation
```
    Since:
    
    3.2.0
  - CHILDREN_COMBINATION_MODE_ATTRIBUTE
```
public static final String CHILDREN_COMBINATION_MODE_ATTRIBUTE
```
    See Also:
    Constant Field Values
  - CHILDREN_COMBINATION_MERGE
```
public static final String CHILDREN_COMBINATION_MERGE
```
    See Also:
    Constant Field Values
  - CHILDREN_COMBINATION_APPEND
```
public static final String CHILDREN_COMBINATION_APPEND
```
    See Also:
    Constant Field Values
  - 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:
    Constant Field Values
  - SELF_COMBINATION_MODE_ATTRIBUTE
```
public static final String SELF_COMBINATION_MODE_ATTRIBUTE
```
    See Also:
    Constant Field Values
  - SELF_COMBINATION_OVERRIDE
```
public static final String SELF_COMBINATION_OVERRIDE
```
    See Also:
    Constant Field Values
  - SELF_COMBINATION_MERGE
```
public static final String SELF_COMBINATION_MERGE
```
    See Also:
    Constant Field Values
  - 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:
    Constant Field Values
- Constructor Detail
  - Xpp3Dom
```
public Xpp3Dom(String name)
```
  - Xpp3Dom
```
public Xpp3Dom(String name,
       Object inputLocation)
```
    Since:
    
    3.2.0
  - Xpp3Dom
```
public Xpp3Dom(Xpp3Dom src)
```
    Copy constructor.
  - Xpp3Dom
```
public Xpp3Dom(Xpp3Dom src,
       String name)
```
    Copy constructor with alternative name.
- Method Detail
  - getName
```
public String getName()
```
  - getValue
```
public String getValue()
```
  - setValue
```
public void setValue(String value)
```
  - getAttributeNames
```
public String[] getAttributeNames()
```
  - getAttribute
```
public String getAttribute(String name)
```
  - setAttribute
```
public void setAttribute(String name,
                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(String name)
```
  - addChild
```
public void addChild(Xpp3Dom xpp3Dom)
```
  - getChildren
```
public Xpp3Dom[] getChildren()
```
  - getChildren
```
public Xpp3Dom[] getChildren(String name)
```
  - getChildCount
```
public int getChildCount()
```
  - removeChild
```
public void removeChild(int i)
```
  - getParent
```
public Xpp3Dom getParent()
```
  - setParent
```
public void setParent(Xpp3Dom parent)
```
  - getInputLocation
```
public Object getInputLocation()
```
    Since:
    
    3.2.0
  - setInputLocation
```
public void setInputLocation(Object inputLocation)
```
    Since:
    
    3.2.0
  - writeToSerializer
```
public void writeToSerializer(String namespace,
                     XmlSerializer serializer)
                       throws IOException
```
    Throws:
    
    IOException
  - 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
    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(Object obj)
```
    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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

value

attributes

childList

childMap

parent

inputLocation

CHILDREN_COMBINATION_MODE_ATTRIBUTE

CHILDREN_COMBINATION_MERGE

CHILDREN_COMBINATION_APPEND

DEFAULT_CHILDREN_COMBINATION_MODE

SELF_COMBINATION_MODE_ATTRIBUTE

SELF_COMBINATION_OVERRIDE

SELF_COMBINATION_MERGE

DEFAULT_SELF_COMBINATION_MODE

Constructor Detail

Xpp3Dom

Xpp3Dom

Xpp3Dom

Xpp3Dom

Method Detail

getName

getValue

setValue

getAttributeNames

getAttribute

setAttribute

getChild

getChild

addChild

getChildren

getChildren

getChildCount

removeChild

getParent

setParent

getInputLocation

setInputLocation

writeToSerializer

mergeXpp3Dom

mergeXpp3Dom

equals

hashCode

toString

toUnescapedString

isNotEmpty

isEmpty