Package ghidra.framework.cmd

Class CompoundCmd<T extends DomainObject>

java.lang.Object
ghidra.framework.cmd.CompoundCmd<T>
Type Parameters:
T - DomainObject implementation interface
All Implemented Interfaces:
Command<T>
public class CompoundCmd<T extends DomainObject> extends Object implements Command<T>
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
    Change
    Constructor
    Description
    CompoundCmd(String name)
    Constructor for CompoundCmd.

  • Method Summary

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

    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 NEW

      public boolean applyTo(T obj)
      Description copied from interface: Command
      Applies the command to the given domain object.
      Specified by:
      applyTo in interface Command<T extends DomainObject>
      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<T extends DomainObject>
      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<T extends DomainObject>
      Returns:
      the name of this command

    • add

      public void add(Command<T> 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.