Package com._1c.g5.v8.dt.refactoring.core

Interface IRenameRefactoringContributor

All Known Implementing Classes:

BslConfigurationObjectRenameContributor, DcsQueryRenameRefactoringContributor, GraphicalSchemeConfigurationObjectRenameContributor, GraphicalSchemeRefactoringContributor, HtmlDocumentMdReferenceRenameRefactoringContributor, HtmlDocumentRenameRefactoringContributor, RightQlRenameRefactoringContributor, RightTemplateRenameRefactoringContributor, TextDocumentRenameRefactoringContributor, XdtoRenameRefactoringContributor

public interface IRenameRefactoringContributor

Clients implement this interface in order to provide custom processing logic responsible for updating objects implicitly connected with the object being renamed.

Method Summary

Modifier and Type	Method	Description
Collection<org.eclipse.ltk.core.refactoring.Change>	createNativePostChanges(org.eclipse.emf.ecore.EObject object, String newName, RefactoringSettings settings, RefactoringStatus status)	Creates LTK changes that is executed after the EDT refactoring operations are performed.
Collection<org.eclipse.ltk.core.refactoring.Change>	createNativePreChanges(org.eclipse.emf.ecore.EObject object, String newName, RefactoringSettings settings, RefactoringStatus status)	Creates LTK changes that is executed before the EDT refactoring operations are performed.
RefactoringOperationDescriptor	createParticipatingOperation(org.eclipse.emf.ecore.EObject object, RefactoringSettings settings, RefactoringStatus status)	The method that is invoked during preparation phase of refactoring. Returns RefactoringOperationDescriptor that performs custom logic for object being renamed.
RefactoringOperationDescriptor	createPreReferenceUpdateParticipatingOperation(IBmObject object, RefactoringSettings settings, RefactoringStatus status)	The method that is invoked during preparation phase of refactoring. Returns RefactoringOperationDescriptor that performs custom logic for object being renamed before the BmObject references processing.

Method Detail

createParticipatingOperation

RefactoringOperationDescriptor createParticipatingOperation(org.eclipse.emf.ecore.EObject object,
                                                            RefactoringSettings settings,
                                                            RefactoringStatus status)

The method that is invoked during preparation phase of refactoring.
Returns RefactoringOperationDescriptor that performs custom logic for object being renamed.

If some conditions are not satisfied the refactoring status should be filled with the appropriate error or warning message.

Parameters:

object - the object being renamed, cannot be null.

settings - the refactoring settings, cannot be null.

status - the refactoring status, cannot be null.

Returns:

refactoring operation descriptor or null.

createPreReferenceUpdateParticipatingOperation

RefactoringOperationDescriptor createPreReferenceUpdateParticipatingOperation(IBmObject object,
                                                                              RefactoringSettings settings,
                                                                              RefactoringStatus status)

The method that is invoked during preparation phase of refactoring.
Returns RefactoringOperationDescriptor that performs custom logic for object being renamed before the BmObject references processing.

If some conditions are not satisfied the refactoring status should be filled with the appropriate error or warning message.

Parameters:

object - the object being renamed, cannot be null.

settings - the refactoring settings, cannot be null.

status - the refactoring status, cannot be null.

Returns:

refactoring operation descriptor or null.

createNativePreChanges

Collection<org.eclipse.ltk.core.refactoring.Change> createNativePreChanges(org.eclipse.emf.ecore.EObject object,
                                                                           String newName,
                                                                           RefactoringSettings settings,
                                                                           RefactoringStatus status)

Creates LTK changes that is executed before the EDT refactoring operations are performed.

If some conditions are not satisfied the refactoring status should be filled with the appropriate error or warning message.

Parameters:

object - the object being renamed, cannot be null.

newName - the new name of the object, cannot be null.

settings - the refactoring settings, cannot be null.

status - the refactoring status, cannot be null.

Returns:

a collection of LTK changes or null.

createNativePostChanges

Collection<org.eclipse.ltk.core.refactoring.Change> createNativePostChanges(org.eclipse.emf.ecore.EObject object,
                                                                            String newName,
                                                                            RefactoringSettings settings,
                                                                            RefactoringStatus status)

Creates LTK changes that is executed after the EDT refactoring operations are performed.

If some conditions are not satisfied the refactoring status should be filled with the appropriate error or warning message.

Parameters:

object - the object being renamed, cannot be null.

newName - the new name of the object, cannot be null.

settings - the refactoring settings, cannot be null.

status - the refactoring status, cannot be null.

Returns:

a collection of LTK changes or null.