Xpp3Dom (Apache Maven Shared Utils 3.3.4 API)

java.lang.Object
- org.apache.maven.shared.utils.xml.Xpp3Dom

All Implemented Interfaces:

Iterable<Xpp3Dom>
```
public class Xpp3Dom
extends Object
implements Iterable<Xpp3Dom>
```
A reimplementation of Plexus Xpp3Dom based on the public interface of Plexus Xpp3Dom.

Author:

Kristian Rosenvold

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CHILDREN_COMBINATION_APPEND` The attribute append.
`static String`	`CHILDREN_COMBINATION_MODE_ATTRIBUTE` The attribute which identifies merge/append.
`static String`	`SELF_COMBINATION_MERGE` The attribute which identifies `merge`
`static String`	`SELF_COMBINATION_MODE_ATTRIBUTE` The name of the attribute.
`static String`	`SELF_COMBINATION_OVERRIDE` The attributes which identifies `override`.

Constructor Summary

Constructors
Constructor and Description

Xpp3Dom(String name)

Xpp3Dom(Xpp3Dom source)
Create instance.

Xpp3Dom(Xpp3Dom src, String name)
Create instance.

Constructors
Constructor and Description
`Xpp3Dom(String name)`
`Xpp3Dom(Xpp3Dom source)` Create instance.
`Xpp3Dom(Xpp3Dom src, String name)` Create instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChild(Xpp3Dom child)`
`boolean`	`equals(Object obj)`
`String`	`getAttribute(String nameParameter)`
`String[]`	`getAttributeNames()`
`Xpp3Dom`	`getChild(int i)`
`Xpp3Dom`	`getChild(String nameParameter)`
`int`	`getChildCount()`
`Xpp3Dom[]`	`getChildren()`
`Xpp3Dom[]`	`getChildren(String nameParameter)`
`String`	`getName()`
`Xpp3Dom`	`getParent()`
`String`	`getValue()`
`int`	`hashCode()`
`static boolean`	`isEmpty(String str)`
`static boolean`	`isNotEmpty(String str)`
`Iterator<Xpp3Dom>`	`iterator()`
`static Xpp3Dom`	`mergeXpp3Dom(Xpp3Dom dominant, Xpp3Dom recessive)`
`static Xpp3Dom`	`mergeXpp3Dom(Xpp3Dom dominant, Xpp3Dom recessive, Boolean childMergeOverride)`
`void`	`removeChild(int i)`
`void`	`setAttribute(String nameParameter, String valueParameter)`
`void`	`setParent(Xpp3Dom parent)`
`void`	`setValue(String value)`
`String`	`toString()`
`String`	`toUnescapedString()`

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - CHILDREN_COMBINATION_MODE_ATTRIBUTE
```
public static final String CHILDREN_COMBINATION_MODE_ATTRIBUTE
```
    The attribute which identifies merge/append.
    
    See Also:
    
    Constant Field Values
  - CHILDREN_COMBINATION_APPEND
```
public static final String CHILDREN_COMBINATION_APPEND
```
    The attribute append.
    
    See Also:
    
    Constant Field Values
  - SELF_COMBINATION_MODE_ATTRIBUTE
```
public static final String SELF_COMBINATION_MODE_ATTRIBUTE
```
    The name of the attribute.
    
    See Also:
    
    Constant Field Values
  - SELF_COMBINATION_OVERRIDE
```
public static final String SELF_COMBINATION_OVERRIDE
```
    The attributes which identifies override.
    
    See Also:
    
    Constant Field Values
  - SELF_COMBINATION_MERGE
```
public static final String SELF_COMBINATION_MERGE
```
    The attribute which identifies merge
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Xpp3Dom
```
public Xpp3Dom(String name)
```
    Parameters:
    
    name - The name of the instance.
  - Xpp3Dom
```
public Xpp3Dom(Xpp3Dom source)
```
    Create instance.
    
    Parameters:
    
    source - The source.
  - Xpp3Dom
```
public Xpp3Dom(@Nonnull
               Xpp3Dom src,
               String name)
```
    Create instance.
    
    Parameters:
    
    src - The source Dom.
    
    name - The name of the Dom.
- Method Detail
  - getName
```
public String getName()
```
    Returns:
    
    The current name.
  - getValue
```
@Nonnull
public String getValue()
```
    Returns:
    
    The current value.
  - setValue
```
public void setValue(@Nonnull
                     String value)
```
    Parameters:
    
    value - The value to be set.
  - getAttributeNames
```
public String[] getAttributeNames()
```
    Returns:
    
    The array of attribute names.
  - getAttribute
```
public String getAttribute(String nameParameter)
```
    Parameters:
    
    nameParameter - The name of the attribute.
    
    Returns:
    
    The attribute value.
  - setAttribute
```
public void setAttribute(@Nonnull
                         String nameParameter,
                         @Nonnull
                         String valueParameter)
```
    Parameters:
    
    nameParameter - The name of the attribute.
    
    valueParameter - The value of the attribute.
  - getChild
```
public Xpp3Dom getChild(int i)
```
    Parameters:
    
    i - The index to be selected.
    
    Returns:
    
    The child selected by index.
  - getChild
```
public Xpp3Dom getChild(String nameParameter)
```
    Parameters:
    
    nameParameter - The name of the child.
    
    Returns:
    
    The child selected by name.
  - addChild
```
public void addChild(Xpp3Dom child)
```
    Parameters:
    
    child - The child to be added.
  - getChildren
```
public Xpp3Dom[] getChildren()
```
    Returns:
    
    The array of childs.
  - getChildren
```
public Xpp3Dom[] getChildren(String nameParameter)
```
    Parameters:
    
    nameParameter - The name of the child.
    
    Returns:
    
    The array of the Dom.
  - getChildCount
```
public int getChildCount()
```
    Returns:
    
    The number of childs.
  - removeChild
```
public void removeChild(int i)
```
    Parameters:
    
    i - The child to be removed.
  - getParent
```
public Xpp3Dom getParent()
```
    Returns:
    
    The current parent.
  - setParent
```
public void setParent(Xpp3Dom parent)
```
    Parameters:
    
    parent - Set the parent.
  - mergeXpp3Dom
```
public static Xpp3Dom mergeXpp3Dom(Xpp3Dom dominant,
                                   Xpp3Dom recessive,
                                   Boolean childMergeOverride)
```
    Parameters:
    
    dominant - The dominant part.
    
    recessive - The recessive part.
    
    childMergeOverride - true if child merge will take precedence false otherwise.
    
    Returns:
    
    The merged Xpp3Dom.
  - mergeXpp3Dom
```
public static Xpp3Dom mergeXpp3Dom(Xpp3Dom dominant,
                                   Xpp3Dom recessive)
```
    Parameters:
    
    dominant - The dominant part.
    
    recessive - The recessive part.
    
    Returns:
    
    The merged Xpp3Dom.
  - 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()
```
    Returns:
    
    Unescaped string.
  - isNotEmpty
```
public static boolean isNotEmpty(String str)
```
    Parameters:
    
    str - The string to be checked.
    
    Returns:
    
    true if the string is not empty (length > 0) and not null.
  - isEmpty
```
public static boolean isEmpty(String str)
```
    Parameters:
    
    str - The string to be checked.
    
    Returns:
    
    true if the string is empty or null.
  - iterator
```
public Iterator<Xpp3Dom> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Xpp3Dom>

Class Xpp3Dom

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

CHILDREN_COMBINATION_MODE_ATTRIBUTE

CHILDREN_COMBINATION_APPEND

SELF_COMBINATION_MODE_ATTRIBUTE

SELF_COMBINATION_OVERRIDE

SELF_COMBINATION_MERGE

Constructor Detail

Xpp3Dom

Xpp3Dom

Xpp3Dom

Method Detail

getName

getValue

setValue

getAttributeNames

getAttribute

setAttribute

getChild

getChild

addChild

getChildren

getChildren

getChildCount

removeChild

getParent

setParent

mergeXpp3Dom

mergeXpp3Dom

equals

hashCode

toString

toUnescapedString

isNotEmpty

isEmpty

iterator