org.eclipse.ltk.core.refactoring.participants

Class ReorgExecutionLog

java.lang.Object

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

public class ReorgExecutionLog
extends java.lang.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

Restriction:

This class is not intended to be subclassed by clients.

Constructor Summary

Constructors

Constructor and Description
ReorgExecutionLog() Creates new reorg execution log

Method Summary

Modifier and Type	Method and Description
java.lang.String	getNewName(java.lang.Object element) Returns the new name of the element.
java.lang.Object[]	getProcessedElements() Returns all processed elements
java.lang.Object[]	getRenamedElements() Returns all elements which got renamed during the reorg refactoring
boolean	isCanceled() Returns true if the reorg refactoring got canceled; otherwise false
boolean	isProcessed(java.lang.Object element) Returns true if the specified element has been processed; otherwise false
boolean	isRenamed(java.lang.Object element) Returns true if the specified element has been renamed; otherwise false
void	markAsCanceled() Logs that the reorg refactoring got canceled by the user.
void	markAsProcessed(java.lang.Object element) Logs that the given element got processed by the refactoring
void	setNewName(java.lang.Object element, java.lang.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

isProcessed

public boolean isProcessed(java.lang.Object element)

Returns true if the specified element has been processed; otherwise false

Parameters:

element - the element to test

Returns:

whether the specified element has been processed

Since:

3.3

isRenamed

public boolean isRenamed(java.lang.Object element)

Returns true if the specified element has been renamed; otherwise false

Parameters:

element - the element to test

Returns:

whether the specified element has been renamed

Since:

3.3

markAsProcessed

public void markAsProcessed(java.lang.Object element)

Logs that the given element got processed by the refactoring

Parameters:

element - the element that got processed

getProcessedElements

public java.lang.Object[] getProcessedElements()

Returns all processed elements

Returns:

all processed elements

setNewName

public void setNewName(java.lang.Object element,
                       java.lang.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 java.lang.Object[] getRenamedElements()

Returns all elements which got renamed during the reorg refactoring

Returns:

the renamed elements

getNewName

public java.lang.String getNewName(java.lang.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