oracle.ide.cmd
Interface HistoryGeneratingCommand

All Known Implementing Classes:

RestoreHistoryCommand, RestoreHistoryRenameCommand

public interface HistoryGeneratingCommand

A HistoryGeneratingCommand is a Command whose invokation should result in the generation of state information as at the completion of the Command. The generation of state is handled by the CommandProcessor via the HistoryManager in the form of a LocalState instance. LocalState instances may later be compared to each other in a differences viewer, or used to restore the contents of a Node to that held by the LocalState.

Method Summary

Node[]	getHistoriedNodes() Get an array of Node whose state should be persisted.
java.lang.String	getName() Gets the name of the command to display as the action to undo
boolean	isGeneratePrecedingState() Determine whether or not the state preceding the invokation of the Command should also be generated if a historied Node is found to be dirty.

Method Detail

getName

java.lang.String getName()

Gets the name of the command to display as the action to undo

getHistoriedNodes

Node[] getHistoriedNodes()

Get an array of Node whose state should be persisted.

Returns:

an array of Node.

isGeneratePrecedingState

boolean isGeneratePrecedingState()

Determine whether or not the state preceding the invokation of the Command should also be generated if a historied Node is found to be dirty.

Generally speaking, implementations should not have to exercise any conditions; Either a preceding state should always be generated (e.g. a refactoring Command), or never generated (e.g. a Save command). The result of this method will only be considered if a historied Node was first found to be dirty before the invokation of the Command.

Commands of type MULTI_DOCUMENT are always treated as HistoryGeneratingCommands and thus need not implement this interface.

Returns:

true if the preceding state should also be generated.