org.xwiki.store.merge

Class MergeDocumentResult

java.lang.Object

org.xwiki.store.merge.MergeManagerResult<DocumentModelBridge,Object>

org.xwiki.store.merge.MergeDocumentResult

@Unstable
public class MergeDocumentResult
extends MergeManagerResult<DocumentModelBridge,Object>

Store information about a merge operation of documents. This object stores the three documents used for the merge, and all results of the different parts of the documents. See putMergeResult(DocumentPart, MergeManagerResult) for more information.

Since:

11.5RC1

Version:

$Id: 75f7e548b6b774ff9d0fe875f15b5ae3ce385597 $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MergeDocumentResult.DocumentPart Represents the different parts of a document that are merged.

Constructor Summary

Constructors

Constructor and Description
MergeDocumentResult(DocumentModelBridge currentDocument, DocumentModelBridge previousDocument, DocumentModelBridge nextDocument) Default constructor.

Method Summary

Modifier and Type	Method and Description
List<org.xwiki.diff.Conflict<?>>	getConflicts(MergeDocumentResult.DocumentPart documentPart) Retrieve the conclicts that occurred during merging a specific part of the document.
DocumentModelBridge	getCurrentDocument()
MergeManagerResult	getMergeResult(MergeDocumentResult.DocumentPart documentPart)
DocumentModelBridge	getNextDocument()
DocumentModelBridge	getPreviousDocument()
void	putMergeResult(MergeDocumentResult.DocumentPart documentPart, MergeManagerResult mergeManagerResult) Stores the result of merging a part of the document.

Methods inherited from class org.xwiki.store.merge.MergeManagerResult

addConflicts, getConflicts, getLog, getMergeResult, hasConflicts, isModified, setMergeResult, setModified

Methods inherited from class java.lang.Object

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

Constructor Detail

MergeDocumentResult

@Unstable
public MergeDocumentResult(DocumentModelBridge currentDocument,
                                     DocumentModelBridge previousDocument,
                                     DocumentModelBridge nextDocument)

Default constructor.

Parameters:

currentDocument - the current document used for the merge.

previousDocument - the previous document used for the merge.

nextDocument - the next document used for the merge.

Since:

11.8RC1

Method Detail

getCurrentDocument

public DocumentModelBridge getCurrentDocument()

Returns:

the current document.

getPreviousDocument

public DocumentModelBridge getPreviousDocument()

Returns:

the previous document.

getNextDocument

public DocumentModelBridge getNextDocument()

Returns:

the next document.

putMergeResult

public void putMergeResult(MergeDocumentResult.DocumentPart documentPart,
                           MergeManagerResult mergeManagerResult)

Stores the result of merging a part of the document. This allows to easily retrieve the information of merging a specific portion of the document. All logs and conflicts are automatically retrieved from the given MergeManagerResult and stored in the current object.

Parameters:

documentPart - the part of the document that has been merged.

mergeManagerResult - the result of the given merge operation.

Since:

11.8RC1

getMergeResult

public MergeManagerResult getMergeResult(MergeDocumentResult.DocumentPart documentPart)

Parameters:

documentPart - a document part that has been merged

Returns:

the information result object of the part merge

Since:

11.8RC1

getConflicts

public List<org.xwiki.diff.Conflict<?>> getConflicts(MergeDocumentResult.DocumentPart documentPart)

Retrieve the conclicts that occurred during merging a specific part of the document.

Parameters:

documentPart - the part of the document that has been merged.

Returns:

a list of conflicts or null. The parameter type of conflicts depends on the document part.

Since:

11.8RC1