public class RefactoringContext extends Object
Refactoring context is a disposable object that can be used by a refactoring to hold resources
that have to be explicitly released. The refactoring context is guaranteed to receive
a dispose()
call after the associated refactoring has finished or produced an error.
At this point, the refactoring context must release all resources and detach all listeners.
A refactoring context can only be disposed once; it cannot be reused.
This class is intended to be subclassed by clients wishing to implement new refactorings that depend on resources that have to be explicitly released.
Constructor and Description |
---|
RefactoringContext(Refactoring refactoring)
Creates a context for the given refactoring.
|
Modifier and Type | Method and Description |
---|---|
void |
dispose()
Disposes of the context.
|
Refactoring |
getRefactoring()
Returns the refactoring associated with the context.
|
public RefactoringContext(Refactoring refactoring)
refactoring
- The refactoring associated with the context. Cannot be null
.NullPointerException
- if refactoring is null
.public Refactoring getRefactoring()
The returned refactoring must be in an initialized state, i.e. ready to
be executed via PerformRefactoringOperation
.
public void dispose()
Subclasses may extend this method (must call super).
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.