Package ghidra.framework.cmd

Interface Command<T extends DomainObject>

Type Parameters:
T - DomainObject implementation interface
All Known Implementing Classes:
AbstractAddMemoryBlockCmd, 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, DecompilerParallelConventionAnalysisCmd, DecompilerParameterIdCmd, DecompilerSwitchAnalysisCmd, DeleteBlockCmd, DeleteFunctionCmd, DeleteFunctionTagCmd, DeleteLabelCmd, DeleteTreeCmd, DeleteVariableCmd, DemanglerCmd, DisassembleCommand, DominanceModularizationCmd, EditRefTypeCmd, ExternalEntryCmd, FillOutStructureCmd, FunctionPurgeAnalysisCmd, FunctionResultStateStackAnalysisCmd, FunctionStackAnalysisCmd, Hcs12DisassembleCommand, MergeableBackgroundCommand, MergeFolderCmd, MipsDisassembleCommand, ModuleAlgorithmCmd, NewFunctionStackAnalysisCmd, PinSymbolCmd, PowerPCDisassembleCommand, ReDisassembleCommand, 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, UpdateFunctionCommand, X86_64DisassembleCommand
public interface Command<T extends DomainObject>
Interface to define a change made to a domain object.

  • Method Summary

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

  • Method Details

    • applyTo

      boolean applyTo(T 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

      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

      String getName()
      Returns the name of this command.
      Returns:
      the name of this command