org.eclipse.ltk.core.refactoring.history
Class RefactoringHistoryEvent
java.lang.Object
org.eclipse.ltk.core.refactoring.history.RefactoringHistoryEvent
-
public final class RefactoringHistoryEvent
- extends
Object
Event object to communicate refactoring history notifications. These include
the addition and removal of refactoring descriptors to the global refactoring
history index.
Refactoring history 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:
-
IRefactoringHistoryListener
,
IRefactoringHistoryService
-
Restriction:
- This class is not intended to be instantiated by clients.
Field Summary
|
static int
|
ADDED
Event type indicating that a refactoring descriptor has been added to its
associated history (value 4) |
static int
|
DELETED
Event type indicating that a refactoring descriptor has been deleted from
its associated history (value 3) |
static int
|
POPPED
Event type indicating that a refactoring descriptor has been popped from
the history stack (value 2) |
static int
|
PUSHED
Event type indicating that a refactoring descriptor has been pushed to
the history stack (value 1) |
Methods inherited from class java.lang.
Object
|
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
|
ADDED
public static final int ADDED
- Event type indicating that a refactoring descriptor has been added to its
associated history (value 4)
-
See Also:
-
Constant Field Values
DELETED
public static final int DELETED
- Event type indicating that a refactoring descriptor has been deleted from
its associated history (value 3)
-
See Also:
-
Constant Field Values
POPPED
public static final int POPPED
- Event type indicating that a refactoring descriptor has been popped from
the history stack (value 2)
-
See Also:
-
Constant Field Values
PUSHED
public static final int PUSHED
- Event type indicating that a refactoring descriptor has been pushed to
the history stack (value 1)
-
See Also:
-
Constant Field Values
RefactoringHistoryEvent
public RefactoringHistoryEvent(
IRefactoringHistoryService service,
int type,
RefactoringDescriptorProxy proxy)
- Creates a new refactoring history 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.