org.codehaus.plexus.metadata.merge

Interface Merger

All Known Implementing Classes:

AbstractMerger, ComponentsXmlMerger, PlexusXmlMerger

public interface Merger

Version:

$Id$

Author:

Rahul Thakur

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROLE

Method Summary

Modifier and Type	Method and Description
org.jdom2.Document	merge(org.jdom2.Document dDocument, org.jdom2.Document rDocument) Merge with the recessive document.
void	mergeDescriptors(File outputDescriptor, List<File> descriptors)
void	writeMergedDocument(org.jdom2.Document mergedDocument, File file) Allows writing out a merged JDom Document to the specified file.

Field Detail

ROLE

static final String ROLE

Method Detail

merge

org.jdom2.Document merge(org.jdom2.Document dDocument,
                         org.jdom2.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

void writeMergedDocument(org.jdom2.Document mergedDocument,
                         File file)
                  throws 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:

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

mergeDescriptors

void mergeDescriptors(File outputDescriptor,
                      List<File> descriptors)
               throws IOException

Throws:

IOException