org.eth.cyril.bugfixer.modeleditor

Class ModelChangeEvents.RenameVariableEvent

java.lang.Object

org.eth.cyril.bugfixer.modeleditor.ModelChangeEvents.RenameVariableEvent

All Implemented Interfaces:

ModelChangeEvent

Enclosing class:

ModelChangeEvents

static class ModelChangeEvents.RenameVariableEvent
extends java.lang.Object
implements ModelChangeEvent

Event that renames a variable.

Constructor Summary

Constructors

Constructor and Description
RenameVariableEvent(Variable variableToRename, java.lang.String newName)

Method Summary

Modifier and Type	Method and Description
java.lang.String	describe() Returns a human-readable description of the event.
java.util.Collection<Variable>	execute(java.util.Collection<Variable> variables) Executes the event.
java.util.Collection<HeapSubStructure>	getModifiedSubStructures() Gets all the heap sub structures which were modified by this model change event.
java.util.Collection<Variable>	undo(java.util.Collection<Variable> variables) Undoes the effects of ModelChangeEvent.execute(Collection).

Methods inherited from class java.lang.Object

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

Constructor Detail

RenameVariableEvent

public RenameVariableEvent(Variable variableToRename,
                           java.lang.String newName)

Method Detail

execute

public java.util.Collection<Variable> execute(java.util.Collection<Variable> variables)

Description copied from interface: ModelChangeEvent

Executes the event.

Specified by:

execute in interface ModelChangeEvent

Parameters:

variables - The collection of variables. This collection should not be changed as no guarantees are made on the kind of collection. Variables can both be added and removed to the result collection to signal that these variables should be added/removed.

Returns:

The collection of variables which should make up the model after executing this event.

undo

public java.util.Collection<Variable> undo(java.util.Collection<Variable> variables)

Description copied from interface: ModelChangeEvent

Undoes the effects of ModelChangeEvent.execute(Collection).

Specified by:

undo in interface ModelChangeEvent

describe

public java.lang.String describe()

Description copied from interface: ModelChangeEvent

Returns a human-readable description of the event.

Specified by:

describe in interface ModelChangeEvent

getModifiedSubStructures

public java.util.Collection<HeapSubStructure> getModifiedSubStructures()

Description copied from interface: ModelChangeEvent

Gets all the heap sub structures which were modified by this model change event. The event is permitted to return an empty list, even if changes have been made. However, optimally an event will give as much information about the modified sub structure as possible. This method only returns a correct result if the ModelChangeEvent.execute(Collection) method has been executed. Otherwise it may throw exceptions or return an incorrect result.

Specified by:

getModifiedSubStructures in interface ModelChangeEvent

Returns:

The list of heap sub structures which were modified by this model change event. May be empty, if the event does not give such information.