org.eth.cyril.bugfixer.modeleditor

Interface ModelChangeEvent

All Known Implementing Classes:

ModelChangeEvents.CompositeChangeEvent, ModelChangeEvents.InsertValueToFieldEvent, ModelChangeEvents.InsertValueToVariableEvent, ModelChangeEvents.RemoveFieldEvent, ModelChangeEvents.RemoveValueEvent, ModelChangeEvents.RenameFieldEvent, ModelChangeEvents.RenameVariableEvent, ModelChangeEvents.SetFieldEvent, ModelChangeEvents.SwapFieldEvent, ModelChangeEvents.SwapValuesEvent

public interface ModelChangeEvent

A model change event is an event which changes the model as given in a HeapContent instance. Any kind of change can be performed in a model change event, and these events support both undo and redo.

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 execute(Collection).

Method Detail

execute

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

Executes the event.

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

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

Undoes the effects of execute(Collection).

describe

java.lang.String describe()

Returns a human-readable description of the event.

getModifiedSubStructures

java.util.Collection<HeapSubStructure> getModifiedSubStructures()

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 execute(Collection) method has been executed. Otherwise it may throw exceptions or return an incorrect result.

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.