org.eclipse.ltk.core.refactoring
Class RefactoringDescriptorProxy

java.lang.Object
  org.eclipse.core.runtime.PlatformObject
      org.eclipse.ltk.core.refactoring.RefactoringDescriptorProxy

All Implemented Interfaces:

Comparable, IAdaptable

public abstract class RefactoringDescriptorProxy

extends PlatformObject

implements Comparable

Proxy of a refactoring descriptor.

Refactoring descriptors are exposed by the refactoring history service as lightweight proxy objects. 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 heavyweight 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 in UTC milliseconds from the epoch (see java.util#Calendar).

Note: this class is not intended to be subclassed and instantiated by clients.

Note: This API is considered experimental and may change in the near future.

Since:

3.2

See Also:

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

RefactoringDescriptorProxy

public RefactoringDescriptorProxy()

Method Detail

compareTo

public int compareTo(Object object)

Specified by:

compareTo in interface Comparable

equals

public final boolean equals(Object object)

getDescription

public abstract String getDescription()

Returns a human-readable description of refactoring.

Returns:

a description of the refactoring

getProject

public abstract String getProject()

Returns the name of the associated project.

Returns:

the non-empty name of the project, or null

getTimeStamp

public abstract long getTimeStamp()

Returns the time stamp of this refactoring.

Returns:

the time stamp, or -1 if no time information is available

hashCode

public final int hashCode()

requestDescriptor

public RefactoringDescriptor requestDescriptor(IProgressMonitor monitor)

Resolves this proxy and returns the associated refactoring descriptor.

Clients must connect to the refactoring history service first before calling this method.

This method is not intended to be overridden outside the refactoring framework.

Parameters:

monitor - the progress monitor to use, or null

Returns:

the refactoring descriptor, or null