Package org.apache.maven.api.xml

Interface Dom

@Experimental
@ThreadSafe
@Immutable
public interface Dom

An immutable xml node.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHILDREN_COMBINATION_APPEND
static final String	CHILDREN_COMBINATION_MERGE
static final String	CHILDREN_COMBINATION_MODE_ATTRIBUTE
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.
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.
static final String	ID_COMBINATION_MODE_ATTRIBUTE	In case of complex XML structures, combining can be done based on id.
static final String	KEYS_COMBINATION_MODE_ATTRIBUTE	In case of complex XML structures, combining can be done based on keys.
static final String	SELF_COMBINATION_MERGE
static final String	SELF_COMBINATION_MODE_ATTRIBUTE
static final String	SELF_COMBINATION_OVERRIDE
static final String	SELF_COMBINATION_REMOVE

Method Summary

Modifier and Type	Method	Description
Dom	clone()
String	getAttribute(String name)
Map<String,String>	getAttributes()
Dom	getChild(String name)
List<Dom>	getChildren()
Object	getInputLocation()
String	getName()
String	getValue()
default Dom	merge(Dom source)
Dom	merge(Dom source, Boolean childMergeOverride)
static Dom	merge(Dom dominant, Dom recessive)	Merge recessive into dominant and return either dominant with merged information or a clone of recessive if dominant is null.
static Dom	merge(Dom dominant, Dom recessive, Boolean childMergeOverride)

Field Details

CHILDREN_COMBINATION_MODE_ATTRIBUTE

static final String CHILDREN_COMBINATION_MODE_ATTRIBUTE

See Also:

• Constant Field Values

CHILDREN_COMBINATION_MERGE

static final String CHILDREN_COMBINATION_MERGE

See Also:

• Constant Field Values

CHILDREN_COMBINATION_APPEND

static final String CHILDREN_COMBINATION_APPEND

See Also:

• Constant Field Values

DEFAULT_CHILDREN_COMBINATION_MODE

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

static final String SELF_COMBINATION_MODE_ATTRIBUTE

See Also:

• Constant Field Values

SELF_COMBINATION_OVERRIDE

static final String SELF_COMBINATION_OVERRIDE

See Also:

• Constant Field Values

SELF_COMBINATION_MERGE

static final String SELF_COMBINATION_MERGE

See Also:

• Constant Field Values

SELF_COMBINATION_REMOVE

static final String SELF_COMBINATION_REMOVE

See Also:

• Constant Field Values

ID_COMBINATION_MODE_ATTRIBUTE

static final String ID_COMBINATION_MODE_ATTRIBUTE

In case of complex XML structures, combining can be done based on id.

See Also:

• Constant Field Values

KEYS_COMBINATION_MODE_ATTRIBUTE

static final String KEYS_COMBINATION_MODE_ATTRIBUTE

In case of complex XML structures, combining can be done based on keys. This is a comma separated list of attribute names.

See Also:

• Constant Field Values

DEFAULT_SELF_COMBINATION_MODE

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

Method Details

getName

@Nonnull
String getName()

getValue

@Nullable
String getValue()

getAttributes

@Nonnull
Map<String,String> getAttributes()

getAttribute

@Nullable
String getAttribute(@Nonnull
 String name)

getChildren

@Nonnull
List<Dom> getChildren()

getChild

@Nullable
Dom getChild(String name)

getInputLocation

@Nullable
Object getInputLocation()

merge

default Dom merge(@Nullable
 Dom source)

merge

Dom merge(@Nullable
 Dom source,
 @Nullable
 Boolean childMergeOverride)

clone

Dom clone()

merge

@Nullable
static Dom merge(@Nullable
 Dom dominant,
 @Nullable
 Dom recessive)

Merge recessive into dominant and return either dominant with merged information or a clone of recessive if dominant is null.

Parameters:

dominant - the node

recessive - if null, nothing will happen

Returns:

the merged node

merge

@Nullable
static Dom merge(@Nullable
 Dom dominant,
 @Nullable
 Dom recessive,
 @Nullable
 Boolean childMergeOverride)