Eclipse Platform
Release 3.1

org.eclipse.ltk.core.refactoring.participants
Class ReorgExecutionLog

java.lang.Object
  extended byorg.eclipse.ltk.core.refactoring.participants.ReorgExecutionLog

public class ReorgExecutionLog
extends Object

Objects of this class can be used as a log to trace the execution of refactorings like copy and paste

This class is not intended to be subclassed by clients.

Since:
3.1

Constructor Summary
ReorgExecutionLog()
          Creates new reorg execution log
 
Method Summary
 String getNewName(Object element)
          Returns the new name of the element.
 Object[] getProcessedElements()
          Returns all processed elements
 Object[] getRenamedElements()
          Returns all elements which got renamed during the reorg refactoring
 boolean isCanceled()
          Returns true if the reorg refactoring got canceled; otherwise false
 void markAsCanceled()
          Logs that the reorg refactoring got canceled by the user.
 void markAsProcessed(Object element)
          Logs that the given element got processed by the refactoring
 void setNewName(Object element, String newName)
          Logs that the element got renamed to newName by the reorg refactoring.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReorgExecutionLog

public ReorgExecutionLog()
Creates new reorg execution log

Method Detail

markAsCanceled

public void markAsCanceled()
Logs that the reorg refactoring got canceled by the user.


isCanceled

public boolean isCanceled()
Returns true if the reorg refactoring got canceled; otherwise false

Returns:
whether the refactoring got canceled or not

markAsProcessed

public void markAsProcessed(Object element)
Logs that the given element got processed by the refactoring

Parameters:
element - the element that got processed

getProcessedElements

public Object[] getProcessedElements()
Returns all processed elements

Returns:
all processed elements

setNewName

public void setNewName(Object element,
                       String newName)
Logs that the element got renamed to newName by the reorg refactoring.

Parameters:
element - the element which got renamed
newName - the new name of the element

getRenamedElements

public Object[] getRenamedElements()
Returns all elements which got renamed during the reorg refactoring

Returns:
the renamed elements

getNewName

public String getNewName(Object element)
Returns the new name of the element. Returns null if the element didn't get renamed.

Parameters:
element - the element for which the new name is requested
Returns:
the new name of null

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

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