Package ghidra.app.cmd.module

Class RenameCmd

java.lang.Object

ghidra.app.cmd.module.RenameCmd

All Implemented Interfaces:

Command<Program>

public class RenameCmd
extends Object
implements Command<Program>

Command for renaming a fragment or a module in listing.

Constructor Summary

Constructors

Constructor	Description
RenameCmd(String treeName, boolean isModule, String oldName, String newName)	Construct a new RenameCmd.
RenameCmd(String treeName, boolean isModule, String oldName, String newName, boolean ignoreDuplicateName)	Construct a new RenameCmd.

Method Summary

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

RenameCmd

public RenameCmd(String treeName,
 boolean isModule,
 String oldName,
 String newName,
 boolean ignoreDuplicateName)

Construct a new RenameCmd.

Parameters:

treeName - name of the tree where the module or fragment resides

isModule - true if a module is to be renamed

oldName - current name of the module or fragment

newName - new name for the module or fragment

ignoreDuplicateName - true means to ignore the exception and don't do anything

RenameCmd

public RenameCmd(String treeName,
 boolean isModule,
 String oldName,
 String newName)

Construct a new RenameCmd.

Parameters:

treeName - name of the tree where the module or fragment resides

isModule - true if a module is to be renamed

oldName - current name of the module or fragment

newName - new name for the module or fragment

Method Details

applyTo

public boolean applyTo(Program program)

Description copied from interface: Command

Applies the command to the given domain object.

Specified by:

applyTo in interface Command<Program>

Parameters:

program - 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