Package ghidra.app.cmd.module

# Class RenameTreeCmd

java.lang.Object
ghidra.app.cmd.module.RenameTreeCmd

All Implemented Interfaces:
  `Command<Program>`

public class RenameTreeCmd extends Object implements Command<Program>
Command to rename a tree in a program; this does not affect the root module of the tree.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `RenameTreeCmd(String oldName, String newName)`
  Constructor for RenameTreeCmd.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `boolean`
  `applyTo(Program p)`
  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.

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

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

- ## Constructor Details

  - ### RenameTreeCmd

    public RenameTreeCmd(String oldName, String newName)
    Constructor for RenameTreeCmd.
    Parameters:
      `oldName` - old name of the tree
      `newName` - new name of the tree

- ## Method Details

  - ### applyTo

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