org.codehaus.plexus.cdc.merge
Interface Merger

All Known Implementing Classes:

AbstractMerger

public interface Merger

Version:

$Id: Merger.java 3514 2006-07-12 13:03:43Z brett $

Author:

Rahul Thakur

Field Summary

static java.lang.String

ROLE

Method Summary

org.jdom.Document	merge(org.jdom.Document dDocument, org.jdom.Document rDocument) Merge with the recessive document.
void	writeMergedDocument(org.jdom.Document mergedDocument, java.io.File file) Allows writing out a merged JDom Document to the specified file.

Field Detail

ROLE

public static final java.lang.String ROLE

Method Detail

merge

public org.jdom.Document merge(org.jdom.Document dDocument,
                               org.jdom.Document rDocument)
                        throws MergeException

Merge with the recessive document.

Parameters:

dDocument - the dominant document.

rDocument - the recessive document.

Returns:

the merged Document instance.

Throws:

MergeException - if there was an error in merge.

writeMergedDocument

public void writeMergedDocument(org.jdom.Document mergedDocument,
                                java.io.File file)
                         throws java.io.IOException

Allows writing out a merged JDom Document to the specified file.

Parameters:

mergedDocument - the merged Document instance.

file - File to write the merged contents to.

Throws:

java.io.IOException - if there was an error while writing merged contents to the specified file.