org.eclipse.ltk.core.refactoring
Class RefactoringDescriptorProxy

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

public class RefactoringDescriptorProxy

extends Object

Proxy to 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() and description getDescription(). In order to access other information such as arguments and comments, clients have to resolve the proxy by calling requestDescriptor(IProgressMonitor) to obtain the refactoring descriptor.

Refactoring descriptors are potentially heavyweight objects which should not be held on to. Proxies which are retrieved from external sources may encapsulate refactoring descriptors and should not be held in memory as well.

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

Constructor Summary

RefactoringDescriptorProxy(String description, long stamp)
Creates a new refactoring descriptor proxy.

Method Summary

String	getDescription() Returns a human-readable description of the particular refactoring instance.
long	getTimeStamp() Returns the time stamp of this refactoring.
RefactoringDescriptor	requestDescriptor(IProgressMonitor monitor) Resolves this proxy and returns the associated refactoring descriptor.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RefactoringDescriptorProxy

public RefactoringDescriptorProxy(String description,
                                  long stamp)

Creates a new refactoring descriptor proxy.

Parameters:

description - a non-empty human-readable description of the particular refactoring instance

stamp - the time stamp of the refactoring

Method Detail

getDescription

public String getDescription()

Returns a human-readable description of the particular refactoring instance.

Returns:

a description of the refactoring

getTimeStamp

public long getTimeStamp()

Returns the time stamp of this refactoring.

Returns:

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

requestDescriptor

public RefactoringDescriptor requestDescriptor(IProgressMonitor monitor)

Resolves this proxy and returns the associated refactoring descriptor.

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

toString

public String toString()