Eclipse Platform
Release 3.2

org.eclipse.ltk.core.refactoring.history
Class RefactoringHistoryEvent

java.lang.Object
  extended byorg.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.

Since:
3.2
See Also:
IRefactoringHistoryListener, IRefactoringHistoryService

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 (value 2)
static int PUSHED
          Event type indicating that a refactoring descriptor has been pushed to the history (value 1)
 
Constructor Summary
RefactoringHistoryEvent(IRefactoringHistoryService service, int type, RefactoringDescriptorProxy proxy)
          Creates a new refactoring history event.
 
Method Summary
 RefactoringDescriptorProxy getDescriptor()
          Returns the refactoring descriptor proxy.
 int getEventType()
          Returns the event type.
 IRefactoringHistoryService getHistoryService()
          Returns the refactoring history service
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

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 (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 (value 1)

See Also:
Constant Field Values
Constructor Detail

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
Method Detail

getDescriptor

public RefactoringDescriptorProxy getDescriptor()
Returns the refactoring descriptor proxy.

Depending on the event, this proxy may not exist 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

Eclipse Platform
Release 3.2

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.