Class CompoundBackgroundCommand<T extends DomainObject>

java.lang.Object
ghidra.framework.cmd.BackgroundCommand<T>
ghidra.framework.cmd.CompoundBackgroundCommand<T>
Type Parameters:
T - DomainObject implementation interface
All Implemented Interfaces:
Command<T>

public class CompoundBackgroundCommand<T extends DomainObject> extends BackgroundCommand<T>
Compound command to handle multiple background commands.
  • Constructor Details

    • CompoundBackgroundCommand

      public CompoundBackgroundCommand(String name, boolean modal, boolean canCancel)
      Constructor
      Parameters:
      name - name of the command
      modal - true means the monitor dialog is modal and the command has to complete or be canceled before any other action can occur
      canCancel - true means the command can be canceled
  • Method Details

    • applyTo

      public boolean applyTo(T obj, TaskMonitor monitor)
      Description copied from class: BackgroundCommand
      Method called when this command is to apply changes to the given domain object. A monitor is provided to display status information about the command as it executes in the background.
      Specified by:
      applyTo in class BackgroundCommand<T extends DomainObject>
      Parameters:
      obj - domain object that will be affected by the command
      monitor - monitor to show progress of the command
      Returns:
      true if the command applied successfully
    • add

      public void add(Command<T> cmd)
      Add a command to this compound background command.
      Parameters:
      cmd - command to be added
    • size

      public int size()
      Get the number of background commands in this compound background command.
      Returns:
      the number of commands
    • isEmpty

      public boolean isEmpty()
      Returns:
      true if no sub-commands have been added