|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.core.runtime.PlatformObject
org.eclipse.ltk.core.refactoring.RefactoringDescriptorProxy
Proxy of a refactoring descriptor.
Refactoring descriptors are exposed by the refactoring history service as
lightweight proxy objects. Refactoring descriptor proxies have an efficient
memory representation and are therefore suited to model huge refactoring
histories which may be displayed in the user interface. The refactoring
history service may hand out any number of proxies for a given descriptor.
Proxies only offer direct access to the time stamp getTimeStamp()
,
the related project getProject()
and description
getDescription()
. In order to access other information such as
arguments and comments, clients have to call
requestDescriptor(IProgressMonitor)
in order to obtain the actual
refactoring descriptor.
Refactoring descriptors are potentially heavy weight objects which should not be held on to. Proxies which are retrieved from external sources (e.g. not from the local refactoring history service) may encapsulate refactoring descriptors and should not be held in memory as well.
All time stamps are measured as the milliseconds since January 1, 1970, 00:00:00 GMT.
Note: this class is not intended to be subclassed by clients.
IRefactoringHistoryService
,
RefactoringHistory
Constructor Summary | |
---|---|
RefactoringDescriptorProxy()
|
Method Summary | |
---|---|
int |
compareTo(Object object)
|
boolean |
equals(Object object)
|
abstract String |
getDescription()
Returns a human-readable description of refactoring. |
abstract String |
getProject()
Returns the name of the associated project. |
abstract long |
getTimeStamp()
Returns the time stamp of this refactoring. |
int |
hashCode()
|
RefactoringDescriptor |
requestDescriptor(IProgressMonitor monitor)
Resolves this proxy and returns the associated refactoring descriptor. |
Methods inherited from class org.eclipse.core.runtime.PlatformObject |
---|
getAdapter |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public RefactoringDescriptorProxy()
Method Detail |
public int compareTo(Object object)
compareTo
in interface Comparable
public final boolean equals(Object object)
public abstract String getDescription()
public abstract String getProject()
null
public abstract long getTimeStamp()
-1
if no time information is
availablepublic final int hashCode()
public RefactoringDescriptor requestDescriptor(IProgressMonitor monitor)
Clients must connect to the refactoring history service first before calling this method.
monitor
- the progress monitor to use, or null
null
|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.