Package com.xpn.xwiki.doc.merge

Class MergeConfiguration

  • public class MergeConfiguration
extends Object
    Allow to define some behaviors of the merge.
    Since:
    3.2M1
    Version:
    $Id: d3fe9ef6930612e6532c77e007772deeaa367597 $

    • Constructor Detail

      • MergeConfiguration

        public MergeConfiguration()

    • Method Detail

      • setProvidedVersionsModifiables

        public void setProvidedVersionsModifiables​(boolean providedVersionsModifiables)
        Parameters:
        providedVersionsModifiables - true if the merge is allowed to modify input elements

      • isProvidedVersionsModifiables

        public boolean isProvidedVersionsModifiables()
        Indicate of the provided previous/new document can be modified.

        By default merge can modify provided documents for performances reasons. For example when the new version of the document contains a new object it's directly moved without being cloned.

        Returns:
        true if merge is allowed to modify provided versions

      • getConcernedDocument

        public DocumentReference getConcernedDocument()
        Returns:
        the reference of the document concerned by this merge.

      • setConcernedDocument

        public void setConcernedDocument​(DocumentReference concernedDocument)
        Specify which document is currently merged.
        Parameters:
        concernedDocument - the reference to the document that is merged.
        Since:
        11.8RC1

      • getUserReference

        public EntityReference getUserReference()
        Returns:
        the reference of the user performing the merge.
        Since:
        11.8RC1

      • setUserReference

        public void setUserReference​(EntityReference userReference)
        Specify which user is performing the merge.
        Parameters:
        userReference - the reference to the user doing the merge.
        Since:
        11.8RC1