org.codehaus.cargo.module.merge
Class DocumentMerger

java.lang.Object
  extended byorg.codehaus.cargo.module.AbstractDescriptorIo
      extended byorg.codehaus.cargo.module.merge.DocumentMerger
All Implemented Interfaces:
MergeProcessor

public class DocumentMerger
extends AbstractDescriptorIo
implements MergeProcessor

Class that can merge two DOM Documents, relatively simply. This works by just importing all the child nodes from the right-hand document into the left-hand document. Create the DocumentMerger, then call addMergeItem successive times with Documents. Finally call performMerge(), which will return you the merged DOM Document. This class may be overridden by subclasses that wish to apply strategies to particular types of XML document.

Version:
$Id: $

Constructor Summary
DocumentMerger()
           
 
Method Summary
 void addMergeItem(java.lang.Object mergeItem)
          Add an item to be merged.
 java.lang.Object performMerge()
          Perform the merge.
 
Methods inherited from class org.codehaus.cargo.module.AbstractDescriptorIo
createDocumentBuilder, writeAll, writeDescriptor, writeDescriptor, writeDescriptor, writeDescriptor
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DocumentMerger

public DocumentMerger()
Method Detail

addMergeItem

public void addMergeItem(java.lang.Object mergeItem)
                  throws MergeException
Add an item to be merged.

Specified by:
addMergeItem in interface MergeProcessor
Parameters:
mergeItem - in the item to merge.
Throws:
MergeException - on exceptions
See Also:
MergeProcessor.addMergeItem(java.lang.Object)

performMerge

public java.lang.Object performMerge()
Perform the merge.

Specified by:
performMerge in interface MergeProcessor
Returns:
the merged artifact
See Also:
MergeProcessor.performMerge()


Copyright © 2004-2008 Codehaus. All Rights Reserved.