Package ghidra.framework.cmd

Interface Command

All Known Implementing Classes:

AbstractCreateStructureCmd, AbstractModularizationCmd, AddBitMappedMemoryBlockCmd, AddByteMappedMemoryBlockCmd, AddExternalNameCmd, AddFileBytesMemoryBlockCmd, AddFunctionTagCmd, AddInitializedMemoryBlockCmd, AddLabelCmd, AddMemoryParameterCommand, AddMemoryVarCmd, AddMemRefCmd, AddMemRefsCmd, AddOffsetMemRefCmd, AddParameterCommand, AddRegisterParameterCommand, AddRegisterRefCmd, AddRegisterVarCmd, AddShiftedMemRefCmd, AddStackParameterCommand, AddStackRefCmd, AddStackVarCmd, AddUninitializedMemoryBlockCmd, AddUniqueLabelCmd, AppendCommentCmd, ApplyFunctionDataTypesCmd, ApplyFunctionSignatureCmd, ArmDisassembleCommand, AssociateSymbolCmd, BackgroundCommand, CaptureFunctionDataTypesCmd, ChangeFunctionTagCmd, ClearEquateCmd, ClearExternalNameCmd, ClearFallThroughCmd, CodeUnitInfoPasteCmd, ComplexityDepthModularizationCmd, CompoundBackgroundCommand, CompoundCmd, CreateArrayCmd, CreateArrayInStructureCmd, CreateDataBackgroundCmd, CreateDataCmd, CreateDataInStructureBackgroundCmd, CreateDataInStructureCmd, CreateDefaultTreeCmd, CreateExternalFunctionCmd, CreateFolderCommand, CreateFragmentCmd, CreateFunctionCmd, CreateFunctionDefinitionCmd, CreateFunctionTagCmd, CreateMultipleFunctionsCmd, CreateNamespacesCmd, CreateStringCmd, CreateStructureCmd, CreateStructureInStructureCmd, CreateThunkFunctionCmd, DeleteBlockCmd, DeleteFunctionCmd, DeleteFunctionTagCmd, DeleteLabelCmd, DeleteTreeCmd, DeleteVariableCmd, DemanglerCmd, DisassembleCommand, DominanceModularizationCmd, EditRefTypeCmd, ExternalEntryCmd, FunctionPurgeAnalysisCmd, FunctionResultStateStackAnalysisCmd, FunctionStackAnalysisCmd, Hcs12DisassembleCommand, MergeableBackgroundCommand, MergeFolderCmd, MipsDisassembleCommand, ModuleAlgorithmCmd, NewFunctionStackAnalysisCmd, PinSymbolCmd, PowerPCDisassembleCommand, RemoveAllReferencesCmd, RemoveExternalNameCmd, RemoveExternalRefCmd, RemoveFunctionTagCmd, RemoveReferenceCmd, RemoveStackDepthChangeCommand, RenameCmd, RenameDataFieldCmd, RenameLabelCmd, RenameTreeCmd, ReorderModuleCmd, SetCommentCmd, SetCommentsCmd, SetEquateCmd, SetExternalNameCmd, SetExternalRefCmd, SetFallThroughCmd, SetFlowOverrideCmd, SetFunctionNameCmd, SetFunctionPurgeCommand, SetFunctionRepeatableCommentCmd, SetFunctionVarArgsCommand, SetLabelNamespaceCmd, SetLabelPrimaryCmd, SetPrimaryRefCmd, SetRegisterCmd, SetReturnDataTypeCmd, SetStackDepthChangeCommand, SetVariableCommentCmd, SetVariableDataTypeCmd, SetVariableNameCmd, SharedReturnAnalysisCmd, SubroutineModelCmd, UpdateExternalNameCmd

public interface Command

Interface to define a change made to a domain object.

Method Summary

Modifier and Type	Method	Description
boolean	applyTo(DomainObject obj)	Applies the command to the given domain object.
java.lang.String	getName()	Returns the name of this command.
java.lang.String	getStatusMsg()	Returns the status message indicating the status of the command.

Method Detail

applyTo

boolean applyTo(DomainObject obj)

Applies the command to the given domain object.

Parameters:

obj - domain object that this command is to be applied.

Returns:

true if the command applied successfully

getStatusMsg

java.lang.String getStatusMsg()

Returns the status message indicating the status of the command.

Returns:

reason for failure, or null if the status of the command was successful

getName

java.lang.String getName()

Returns the name of this command.

Returns:

the name of this command