Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

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

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

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire