Package ghidra.framework.cmd

# Interface BinaryAnalysisCommand

All Superinterfaces:
  `ExtensionPoint`

All Known Implementing Classes:
  `AppleSingleDoubleBinaryAnalysisCommand`, `CoffArchiveBinaryAnalysisCommand`, `CoffBinaryAnalysisCommand`, `ElfBinaryAnalysisCommand`, `MachoBinaryAnalysisCommand`, `PefBinaryAnalysisCommand`, `PortableExecutableBinaryAnalysisCommand`

public interface BinaryAnalysisCommand extends ExtensionPoint
NOTE: ALL BinaryAnalysisCommand CLASSES MUST END IN "BinaryAnalysisCommand". If not, the ClassSearcher will not find them.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `boolean`
  `applyTo(Program program, TaskMonitor monitor)`
  Applies the command to the given domain object.
  `boolean`
  `canApply(Program program)`
  Returns TRUE if this command can be applied to the given domain object.
  `MessageLog`
  `getMessages()`
  Returns the status message indicating the status of the command.
  `String`
  `getName()`
  Returns the name of this command.

- ## Method Details

  - ### canApply

    boolean canApply(Program program)
    Returns TRUE if this command can be applied to the given domain object.
    Parameters:
      `program` - the domain object to inspect.
    Returns:
      TRUE if this command can be applied

  - ### applyTo

    boolean applyTo(Program program, TaskMonitor monitor) throws Exception
    Applies the command to the given domain object.
    Parameters:
      `program` - domain object that this command is to be applied.
      `monitor` - the task monitor
    Returns:
      true if the command applied successfully
    Throws:
      `Exception`

  - ### getMessages

    MessageLog getMessages()
    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