|
Eclipse Platform Release 4.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ltk.core.refactoring.RefactoringContext
public class RefactoringContext
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 Summary | |
---|---|
RefactoringContext(Refactoring refactoring)
Creates a context for the given refactoring. |
Method Summary | |
---|---|
void |
dispose()
Disposes of the context. |
Refactoring |
getRefactoring()
Returns the refactoring associated with the context. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RefactoringContext(Refactoring refactoring)
refactoring
- The refactoring associated with the context. Cannot be null
.
NullPointerException
- if refactoring is null
.Method Detail |
---|
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).
|
Eclipse Platform Release 4.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2013. All rights reserved.