org.codehaus.plexus.util.xml

Class Xpp3Dom


public class Xpp3Dom
extends java.lang.Object

Version:
$Id: Xpp3Dom.java 5958 2007-02-28 10:29:55Z olamy $

Field Summary

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.
static String
SELF_COMBINATION_MERGE
static String
SELF_COMBINATION_MODE_ATTRIBUTE
static String
SELF_COMBINATION_OVERRIDE
protected Map
attributes
protected List
childList
protected Map
childMap
protected String
name
protected Xpp3Dom
parent
protected String
value

Constructor Summary

Xpp3Dom(String name)
Xpp3Dom(Xpp3Dom src)

Method Summary

void
addChild(Xpp3Dom xpp3Dom)
boolean
equals(Object obj)
String
getAttribute(String name)
String[]
getAttributeNames()
Xpp3Dom
getChild(String name)
Xpp3Dom
getChild(int i)
int
getChildCount()
Xpp3Dom[]
getChildren()
Xpp3Dom[]
getChildren(String name)
String
getName()
Xpp3Dom
getParent()
String
getValue()
int
hashCode()
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
setParent(Xpp3Dom parent)
void
setValue(String value)
String
toString()
String
toUnescapedString()
void
writeToSerializer(String namespace, XmlSerializer serializer)

Field Details

CHILDREN_COMBINATION_APPEND

public static final String CHILDREN_COMBINATION_APPEND

CHILDREN_COMBINATION_MERGE

public static final String CHILDREN_COMBINATION_MERGE

CHILDREN_COMBINATION_MODE_ATTRIBUTE

public static final String CHILDREN_COMBINATION_MODE_ATTRIBUTE

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.

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.

SELF_COMBINATION_MERGE

public static final String SELF_COMBINATION_MERGE

SELF_COMBINATION_MODE_ATTRIBUTE

public static final String SELF_COMBINATION_MODE_ATTRIBUTE

SELF_COMBINATION_OVERRIDE

public static final String SELF_COMBINATION_OVERRIDE

attributes

protected Map attributes

childList

protected List childList

childMap

protected Map childMap

name

protected String name

parent

protected Xpp3Dom parent

value

protected String value

Constructor Details

Xpp3Dom

public Xpp3Dom(String name)

Xpp3Dom

public Xpp3Dom(Xpp3Dom src)

Method Details

addChild

public void addChild(Xpp3Dom xpp3Dom)

equals

public boolean equals(Object obj)

getAttribute

public String getAttribute(String name)

getAttributeNames

public String[] getAttributeNames()

getChild

public Xpp3Dom getChild(String name)

getChild

public Xpp3Dom getChild(int i)

getChildCount

public int getChildCount()

getChildren

public Xpp3Dom[] getChildren()

getChildren

public Xpp3Dom[] getChildren(String name)

getName

public String getName()

getParent

public Xpp3Dom getParent()

getValue

public String getValue()

hashCode

public int hashCode()

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

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

removeChild

public void removeChild(int i)

setAttribute

public void setAttribute(String name,
                         String value)
Set the attribute value
Parameters:
name - String not null
value - String not null

setParent

public void setParent(Xpp3Dom parent)

setValue

public void setValue(String value)

toString

public String toString()

toUnescapedString

public String toUnescapedString()

writeToSerializer

public void writeToSerializer(String namespace,
                              XmlSerializer serializer)
            throws IOException