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
Interface IRefactoringHistoryService


public interface IRefactoringHistoryService

Interface for a refactoring history service. A refactoring history service provides methods to register refactoring history listeners, refactoring execution listeners and facilities to query the global refactoring history index for specific refactoring histories. Additionally, methods are provided which read or write refactoring information. The refactoring history service only returns refactorings which have contributed a refactoring descriptor via their change object.

An instance of a refactoring history service may be obtained by calling RefactoringCore.getHistoryService().

All time stamps are measured as the milliseconds since January 1, 1970, 00:00:00 GMT.

Note: this interface is not intended to be implemented by clients.

Since:
3.2
See Also:
RefactoringCore, IRefactoringHistoryListener, IRefactoringExecutionListener, RefactoringHistory, RefactoringDescriptorProxy
Restriction:
This interface is not intended to be implemented by clients.
Restriction:
This interface is not intended to be extended by clients.

Method Summary
 void addExecutionListener ( IRefactoringExecutionListener listener)
          Adds the specified refactoring execution listener to this service.
 void addHistoryListener ( IRefactoringHistoryListener listener)
          Adds the specified refactoring history listener to this service.
 void connect ()
          Connects the refactoring history service to the workbench's operation history if necessary and increments an internal counter.
 void disconnect ()
          Disconnects the refactoring history service from the workbench's operation history if necessary and decrements an internal counter.
  RefactoringHistory getProjectHistory ( IProject project, IProgressMonitor monitor)
          Returns a project refactoring history for the specified project.
  RefactoringHistory getProjectHistory ( IProject project, long start, long end, int flags, IProgressMonitor monitor)
          Returns a project refactoring history for the specified project.
  RefactoringHistory getRefactoringHistory ( IProject[] projects, IProgressMonitor monitor)
          Returns the combined refactoring history for the specified projects.
  RefactoringHistory getRefactoringHistory ( IProject[] projects, long start, long end, int flags, IProgressMonitor monitor)
          Returns the combined refactoring history for the specified projects.
  RefactoringHistory getWorkspaceHistory ( IProgressMonitor monitor)
          Returns the workspace refactoring history.
  RefactoringHistory getWorkspaceHistory (long start, long end, IProgressMonitor monitor)
          Returns the workspace refactoring history.
  RefactoringHistory readRefactoringHistory ( InputStream stream, int flags)
          Reads a refactoring history from the input stream.
 void removeExecutionListener ( IRefactoringExecutionListener listener)
          Removes the specified refactoring execution listener from this service.
 void removeHistoryListener ( IRefactoringHistoryListener listener)
          Removes the specified refactoring history listener from this service.
 void writeRefactoringDescriptors ( RefactoringDescriptorProxy[] proxies, OutputStream stream, int flags, boolean time, IProgressMonitor monitor)
          Writes the specified refactoring descriptor proxies to the output stream.
 void writeRefactoringSession ( RefactoringSessionDescriptor descriptor, OutputStream stream, boolean time)
          Writes the specified refactoring session descriptor to the output stream.
 

Method Detail

addExecutionListener

void addExecutionListener(
IRefactoringExecutionListener listener)
Adds the specified refactoring execution listener to this service.

If the listener is already registered with the service, nothing happens.

Parameters:
listener - the listener to add

addHistoryListener

void addHistoryListener(
IRefactoringHistoryListener listener)
Adds the specified refactoring history listener to this service.

If the listener is already registered with the service, nothing happens.

Parameters:
listener - the listener to add

connect

void connect()
Connects the refactoring history service to the workbench's operation history if necessary and increments an internal counter.

If the service is already connected, nothing happens.

Every call to connect() must be balanced with a corresponding call to disconnect().


disconnect

void disconnect()
Disconnects the refactoring history service from the workbench's operation history if necessary and decrements an internal counter.

If the service is not connected, nothing happens. If the service is connected, all resources acquired since the corresponding call to connect() are released.

Every call to disconnect() must be balanced with a corresponding call to connect().


getProjectHistory

RefactoringHistory getProjectHistory(
IProject project,
                                     
IProgressMonitor monitor)
Returns a project refactoring history for the specified project.

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

Parameters:
project - the project, which must exist
monitor - the progress monitor to use, or null if no progress monitoring or cancelation is desired
Returns:
the project refactoring history

getProjectHistory

RefactoringHistory getProjectHistory(
IProject project,
                                     long start,
                                     long end,
                                     int flags,
                                     
IProgressMonitor monitor)
Returns a project refactoring history for the specified project.

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

Note that calling this method with a flag argument unequal to RefactoringDescriptor#NONE may result in a performance degradation, since the actual descriptors have to be eagerly resolved. This in turn results in faster execution of any subsequent calls to RefactoringDescriptorProxy.requestDescriptor(IProgressMonitor) which try to request a descriptor from the returned refactoring history.

Parameters:
project - the project, which must exist
start - the start time stamp, inclusive
end - the end time stamp, inclusive
flags - the refactoring descriptor flags which must be present in order to be returned in the refactoring history object, or RefactoringDescriptor#NONE
monitor - the progress monitor to use, or null if no progress monitoring or cancelation is desired
Returns:
the project refactoring history

getRefactoringHistory

RefactoringHistory getRefactoringHistory(
IProject[] projects,
                                         
IProgressMonitor monitor)
Returns the combined refactoring history for the specified projects.

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

Parameters:
projects - the projects, which must exist
monitor - the progress monitor to use, or null if no progress monitoring or cancelation is desired
Returns:
the combined refactoring history

getRefactoringHistory

RefactoringHistory getRefactoringHistory(
IProject[] projects,
                                         long start,
                                         long end,
                                         int flags,
                                         
IProgressMonitor monitor)
Returns the combined refactoring history for the specified projects.

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

Note that calling this method with a flag argument unequal to RefactoringDescriptor#NONE may result in a performance degradation, since the actual descriptors have to be eagerly resolved. This in turn results in faster execution of any subsequent calls to RefactoringDescriptorProxy.requestDescriptor(IProgressMonitor) which try to request a descriptor from the returned refactoring history.

Parameters:
projects - the projects, which must exist
start - the start time stamp, inclusive
end - the end time stamp, inclusive
flags - the refactoring descriptor flags which must be present in order to be returned in the refactoring history object, or RefactoringDescriptor#NONE
monitor - the progress monitor to use, or null if no progress monitoring or cancelation is desired
Returns:
the combined refactoring history

getWorkspaceHistory

RefactoringHistory getWorkspaceHistory(
IProgressMonitor monitor)
Returns the workspace refactoring history.

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

Parameters:
monitor - the progress monitor to use, or null if no progress monitoring or cancelation is desired
Returns:
the workspace refactoring history

getWorkspaceHistory

RefactoringHistory getWorkspaceHistory(long start,
                                       long end,
                                       
IProgressMonitor monitor)
Returns the workspace refactoring history.

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

Parameters:
start - the start time stamp, inclusive
end - the end time stamp, inclusive
monitor - the progress monitor to use, or null if no progress monitoring or cancelation is desired
Returns:
the workspace refactoring history

readRefactoringHistory

RefactoringHistory readRefactoringHistory(
InputStream stream,
                                          int flags)
                                          throws 
CoreException
Reads a refactoring history from the input stream.

The resulting refactoring history contains resolved refactoring descriptors and should not be held on to.

It is the responsibility of the caller to close the input stream.

Parameters:
stream - a UTF-8 input stream where to read the refactoring history from
flags - the refactoring descriptor flags to filter the refactoring descriptors
Returns:
a refactoring history containing the filtered refactoring descriptors
Throws:
CoreException - if an error occurs while reading form the input stream. Reasons include:
  • The input stream contains no version information for the refactoring history.
  • The input stream contains an unsupported version of a refactoring history.
  • An I/O error occurs while reading the refactoring history from the input stream.
See Also:
RefactoringDescriptor.NONE, RefactoringDescriptor.STRUCTURAL_CHANGE, RefactoringDescriptor.BREAKING_CHANGE, IRefactoringCoreStatusCodes.REFACTORING_HISTORY_IO_ERROR, IRefactoringCoreStatusCodes.UNSUPPORTED_REFACTORING_HISTORY_VERSION, IRefactoringCoreStatusCodes.MISSING_REFACTORING_HISTORY_VERSION

removeExecutionListener

void removeExecutionListener(
IRefactoringExecutionListener listener)
Removes the specified refactoring execution listener from this service.

If the listener is not registered with the service, nothing happens.

Parameters:
listener - the listener to remove

removeHistoryListener

void removeHistoryListener(
IRefactoringHistoryListener listener)
Removes the specified refactoring history listener from this service.

If the listener is not registered with the service, nothing happens.

Parameters:
listener - the listener to remove

writeRefactoringDescriptors

void writeRefactoringDescriptors(
RefactoringDescriptorProxy[] proxies,
                                 
OutputStream stream,
                                 int flags,
                                 boolean time,
                                 
IProgressMonitor monitor)
                                 throws 
CoreException
Writes the specified refactoring descriptor proxies to the output stream. Refactoring descriptor proxies which cannot be resolved are automatically skipped.

It is the responsibility of the caller to close the output stream.

Parameters:
proxies - the refactoring descriptor proxies
stream - a UTF-8 output stream where to write the refactoring descriptors to
flags - the flags which must be present in order to be written to the output stream, or RefactoringDescriptor#NONE
time - true to write time information associated with the refactorings, false otherwise
monitor - the progress monitor to use, or null if no progress monitoring or cancelation is desired
Throws:
CoreException - if an error occurs while writing to the output stream. Reasons include:
  • The refactoring descriptors have an illegal format, contain illegal arguments or otherwise illegal information.
  • An I/O error occurs while writing the refactoring descriptors to the output stream.
See Also:
RefactoringDescriptor.NONE, RefactoringDescriptor.STRUCTURAL_CHANGE, RefactoringDescriptor.BREAKING_CHANGE, IRefactoringCoreStatusCodes.REFACTORING_HISTORY_FORMAT_ERROR, IRefactoringCoreStatusCodes.REFACTORING_HISTORY_IO_ERROR

writeRefactoringSession

void writeRefactoringSession(
RefactoringSessionDescriptor descriptor,
                             
OutputStream stream,
                             boolean time)
                             throws 
CoreException
Writes the specified refactoring session descriptor to the output stream.

It is the responsibility of the caller to close the output stream.

Parameters:
descriptor - the refactoring session descriptor to write
stream - a UTF-8 output stream where to write the refactoring session to
time - true to write time information associated with the refactorings, false otherwise
Throws:
CoreException - if an error occurs while writing to the output stream. Reasons include:
  • The refactoring descriptors have an illegal format, contain illegal arguments or otherwise illegal information.
  • An I/O error occurs while writing the refactoring descriptors to the output stream.
See Also:
IRefactoringCoreStatusCodes.REFACTORING_HISTORY_FORMAT_ERROR, IRefactoringCoreStatusCodes.REFACTORING_HISTORY_IO_ERROR

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