Eclipse Platform
Release 3.2

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

java.lang.Object
  extended byorg.eclipse.core.runtime.PlatformObject
      extended byorg.eclipse.ltk.core.refactoring.history.RefactoringHistory
All Implemented Interfaces:
IAdaptable

public abstract class RefactoringHistory
extends PlatformObject

Object which represents a sequence of executed refactorings with optional time information.

Refactoring histories are exposed by the refactoring history service as result of queries and contain only lightweight proxy objects. The refactoring history service may hand out any number of refactoring histories and associated refactoring descriptor proxies for any given query.

Note: this class may be extended to provide different implementations

Since:
3.2
See Also:
IRefactoringHistoryService, RefactoringDescriptorProxy

Constructor Summary
RefactoringHistory()
           
 
Method Summary
abstract  RefactoringDescriptorProxy[] getDescriptors()
          Returns the refactoring descriptors of this history, in descending order of their time stamps.
abstract  boolean isEmpty()
          Is the refactoring history empty?
abstract  RefactoringHistory removeAll(RefactoringHistory history)
          Returns this refactoring history with all entries from the other history removed.
 
Methods inherited from class org.eclipse.core.runtime.PlatformObject
getAdapter
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RefactoringHistory

public RefactoringHistory()
Method Detail

getDescriptors

public abstract RefactoringDescriptorProxy[] getDescriptors()
Returns the refactoring descriptors of this history, in descending order of their time stamps.

Returns:
the refactoring descriptors, or an empty array

isEmpty

public abstract boolean isEmpty()
Is the refactoring history empty?

Returns:
true if the history is empty, false otherwise

removeAll

public abstract RefactoringHistory removeAll(RefactoringHistory history)
Returns this refactoring history with all entries from the other history removed.

The current refactoring history remains unchanged.

Parameters:
history - the refactoring history
Returns:
the resulting refactoring history

Eclipse Platform
Release 3.2

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.