Package com.intellij.refactoring.listeners

Interface RefactoringEventListener

public interface RefactoringEventListener

Listener to get high level notifications about performed refactorings in the selected project. RefactoringEventData depends on the refactoring performed. It should reflect state of the data before/after refactoring.

Field Summary

Fields

Modifier and Type	Field and Description
static Topic<RefactoringEventListener>	REFACTORING_EVENT_TOPIC Entry point to attach a client listener.

Method Summary

Modifier and Type	Method and Description
void	conflictsDetected(java.lang.String refactoringId, RefactoringEventData conflictsData) Is fired when conflicts are detected.
void	refactoringDone(java.lang.String refactoringId, RefactoringEventData afterData) Is fired when refactoring is completed, probably with conflicts.
void	refactoringStarted(java.lang.String refactoringId, RefactoringEventData beforeData) Is fired when refactoring enters its write phase (find usages, conflict detection phases are passed already)
void	undoRefactoring(java.lang.String refactoringId) Is fired when undoable action created on refactoring execution is undone.

Field Detail

REFACTORING_EVENT_TOPIC

static final Topic<RefactoringEventListener> REFACTORING_EVENT_TOPIC

Entry point to attach a client listener. Events are posted on the project bus and its children so connection should be done as following project.getMessageBus().connect(Disposable).subscribe(RefactoringEventListener.REFACTORING_EVENT_TOPIC, new Listener())

Method Detail

refactoringStarted

void refactoringStarted(java.lang.String refactoringId,
                        RefactoringEventData beforeData)

Is fired when refactoring enters its write phase (find usages, conflict detection phases are passed already)

refactoringDone

void refactoringDone(java.lang.String refactoringId,
                     RefactoringEventData afterData)

Is fired when refactoring is completed, probably with conflicts.

conflictsDetected

void conflictsDetected(java.lang.String refactoringId,
                       RefactoringEventData conflictsData)

Is fired when conflicts are detected. If the next event comes from the same refactoring then conflicts were ignored.

Parameters:

conflictsData - should contain string representation of the conflicts

undoRefactoring

void undoRefactoring(java.lang.String refactoringId)

Is fired when undoable action created on refactoring execution is undone.