Package ghidra.framework.cmd

# Class CompoundCmd

java.lang.Object
ghidra.framework.cmd.CompoundCmd

All Implemented Interfaces:
  `Command`

public class CompoundCmd extends Object implements Command
Implementation for multiple commands that are done as a unit. Multiple commands may be added to this one so that multiple changes can be applied to the domain object as unit.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `CompoundCmd(String name)`
  Constructor for CompoundCmd.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `add(Command cmd)`
  Add the given command to this command.
  `boolean`
  `applyTo(DomainObject 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.
  `int`
  `size()`
  Return the number of commands that are part of this compound command.

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### CompoundCmd

    public CompoundCmd(String name)
    Constructor for CompoundCmd.
    Parameters:
      `name` - the name of the command

- ## Method Details

  - ### applyTo

    public boolean applyTo(DomainObject obj)
    Description copied from interface: `Command`
    Applies the command to the given domain object.
    Specified by:
      `applyTo` in interface `Command`
    Parameters:
      `obj` - domain object that this command is to be applied.
    Returns:
      true if the command applied successfully

  - ### getStatusMsg

    public String getStatusMsg()
    Description copied from interface: `Command`
    Returns the status message indicating the status of the command.
    Specified by:
      `getStatusMsg` in interface `Command`
    Returns:
      reason for failure, or null if the status of the command was successful

  - ### getName

    public String getName()
    Description copied from interface: `Command`
    Returns the name of this command.
    Specified by:
      `getName` in interface `Command`
    Returns:
      the name of this command

  - ### add

    public void add(Command cmd)
    Add the given command to this command.
    Parameters:
      `cmd` - command to add to this command

  - ### size

    public int size()
    Return the number of commands that are part of this compound command.
    Returns:
      the number of commands that have been added to this one.