org.eclipse.ltk.core.refactoring.history
Class RefactoringExecutionEvent
java.lang.Object
org.eclipse.ltk.core.refactoring.history.RefactoringExecutionEvent
-
public final class RefactoringExecutionEvent
- extends
Object
Event object to communicate refactoring execution notifications. These
include before-the-fact notification of perform, undo and redo refactoring
operations as well as after-the-fact notification of the above refactoring
operations.
Refactoring execution listeners must be prepared to receive notifications
from a background thread. Any UI access occurring inside the implementation
must be properly synchronized using the techniques specified by the client's
widget library.
Note: this class is not intended to be instantiated by clients.
-
Since:
- 3.2
-
See Also:
-
IRefactoringExecutionListener
,
IRefactoringHistoryService
-
Restriction:
- This class is not intended to be instantiated by clients.
Field Summary
|
static int
|
ABOUT_TO_PERFORM
Event type indicating that a refactoring is about to be performed (value 4) |
static int
|
ABOUT_TO_REDO
Event type indicating that a refactoring is about to be redone (value 6) |
static int
|
ABOUT_TO_UNDO
Event type indicating that a refactoring is about to be undone (value 5) |
static int
|
PERFORMED
Event type indicating that a refactoring has been performed (value 1) |
static int
|
REDONE
Event type indicating that a refactoring has been performed (value 3) |
static int
|
UNDONE
Event type indicating that a refactoring has been undone (value 2) |
Methods inherited from class java.lang.
Object
|
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
|
ABOUT_TO_PERFORM
public static final int ABOUT_TO_PERFORM
- Event type indicating that a refactoring is about to be performed (value 4)
-
See Also:
-
Constant Field Values
ABOUT_TO_REDO
public static final int ABOUT_TO_REDO
- Event type indicating that a refactoring is about to be redone (value 6)
-
See Also:
-
Constant Field Values
ABOUT_TO_UNDO
public static final int ABOUT_TO_UNDO
- Event type indicating that a refactoring is about to be undone (value 5)
-
See Also:
-
Constant Field Values
PERFORMED
public static final int PERFORMED
- Event type indicating that a refactoring has been performed (value 1)
-
See Also:
-
Constant Field Values
REDONE
public static final int REDONE
- Event type indicating that a refactoring has been performed (value 3)
-
See Also:
-
Constant Field Values
UNDONE
public static final int UNDONE
- Event type indicating that a refactoring has been undone (value 2)
-
See Also:
-
Constant Field Values
RefactoringExecutionEvent
public RefactoringExecutionEvent(
IRefactoringHistoryService service,
int type,
RefactoringDescriptorProxy proxy)
- Creates a new refactoring execution event.
-
Parameters:
-
service
- the refactoring history service -
type
- the event type -
proxy
- the refactoring descriptor proxy
getDescriptor
public
RefactoringDescriptorProxy getDescriptor()
- Returns the refactoring descriptor proxy.
Depending on the event, this proxy may refer to an inexisting refactoring
and cannot be resolved to a refactoring descriptor. Clients should also
be prepared to receive notifications for unknown refactorings, which are
discriminated by their special id
RefactoringDescriptor.ID_UNKNOWN
;
-
-
Returns:
- the refactoring descriptor proxy
getEventType
public int getEventType()
- Returns the event type.
-
-
Returns:
- the event type
getHistoryService
public
IRefactoringHistoryService getHistoryService()
- Returns the refactoring history service
-
-
Returns:
- the refactoring history service
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.