Package org.xwiki.extension.xar

Interface XWikiDocumentMerger

@Role
public interface XWikiDocumentMerger

Return an instance of XWikiDocument which is the result of a merge based on the provided input.

Since:

10.3

Version:

$Id: 5712691791e8e281f0b0eac2e6aa506183ddff56 $

Method Summary

Modifier and Type	Method	Description
XWikiDocument	merge(XWikiDocument currentDocument, XWikiDocument previousDocument, XWikiDocument nextDocument, XWikiDocumentMergerConfiguration configuration)

Method Detail

merge

XWikiDocument merge(XWikiDocument currentDocument,
                    XWikiDocument previousDocument,
                    XWikiDocument nextDocument,
                    XWikiDocumentMergerConfiguration configuration)
             throws XarExtensionException

Parameters:

currentDocument - the document currently in database

previousDocument - the standard version of the document

nextDocument - the new standard version of the document

configuration - the configuration of the merge

Returns:

the result of the merge

Throws:

XarExtensionException - when failing to execute the merge