org.xwiki.refactoring

Interface ReferenceRenamer

@Unstable
 @Role
public interface ReferenceRenamer

Allow to replace references during rename/move refactoring operations.

Since:

13.4RC1

Version:

$Id: 578f93968841e1255e2bc5dd09ce4553da53f123 $

Method Summary

Modifier and Type	Method and Description
boolean	renameReferences(org.xwiki.rendering.block.Block block, org.xwiki.model.reference.DocumentReference currentDocumentReference, org.xwiki.model.reference.DocumentReference oldTarget, org.xwiki.model.reference.DocumentReference newTarget, boolean relative) Change references of the given block so that the references pointing to the old target points to the new target.

Method Detail

renameReferences

boolean renameReferences(org.xwiki.rendering.block.Block block,
                         org.xwiki.model.reference.DocumentReference currentDocumentReference,
                         org.xwiki.model.reference.DocumentReference oldTarget,
                         org.xwiki.model.reference.DocumentReference newTarget,
                         boolean relative)

Change references of the given block so that the references pointing to the old target points to the new target.

Parameters:

block - the Block to modify

currentDocumentReference - the current document reference

oldTarget - the previous reference of the renamed document

newTarget - the new reference of the renamed document

relative - true if the link should be serialized relatively to the current document (see LinkRefactoring.updateRelativeLinks(org.xwiki.model.reference.DocumentReference, org.xwiki.model.reference.DocumentReference))

Returns:

true if the given Block was modified