org.atteo.config.xmlmerge

Class XmlCombiner

java.lang.Object

org.atteo.config.xmlmerge.XmlCombiner

public class XmlCombiner
extends Object

Combines two or more XML DOM trees.

The merging algorithm is as follows:
First direct subelements of selected node are examined. The elements from both trees with matching tag names and the value of 'id' attributes are paired. Based on selected behavior the content of the paired elements is then merged. Finally the paired elements are recursively combined. Any not paired elements are appended.

You can control merging behavior using 'combine.self' and 'combine.children' attributes.

The merging algorithm was inspired by similar functionality in Plexus Utils.

See Also:

merging in Maven, Plexus utils implementation of merging

Constructor Summary

Constructors

Constructor and Description
XmlCombiner() Creates XML combiner using default DocumentBuilder.
XmlCombiner(DocumentBuilder documentBuilder)

Method Summary

Methods

Modifier and Type	Method and Description
Document	buildDocument()
void	combine(Document document) Combine given document.
void	combine(Element element) Combine given element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlCombiner

public XmlCombiner()
            throws ParserConfigurationException

Creates XML combiner using default DocumentBuilder.

Throws:

ParserConfigurationException - when DocumentBuilder creation fails

XmlCombiner

public XmlCombiner(DocumentBuilder documentBuilder)

Method Detail

combine

public void combine(Document document)

Combine given document.

Parameters:

document - document to combine

combine

public void combine(Element element)

Combine given element.

Parameters:

element - element to combine

buildDocument

public Document buildDocument()