Package ghidra.app.cmd.label

Class RenameLabelCmd

java.lang.Object

ghidra.app.cmd.label.RenameLabelCmd

All Implemented Interfaces:

Command

public class RenameLabelCmd
extends java.lang.Object
implements Command

Command for renaming labels. Handles converting back and forth between default and named labels as well.

Constructor Summary

Constructors

Constructor	Description
RenameLabelCmd(Address addr, java.lang.String oldName, java.lang.String newName, Namespace currentNamespace, Namespace newNamespace, SourceType source)	Constructs a new command for renaming a label within currentNamespace and changing the namespace to newNamespace.
RenameLabelCmd(Address addr, java.lang.String oldName, java.lang.String newName, Namespace currentNamespace, SourceType source)	Constructs a new command for renaming a label within a specified namespace.
RenameLabelCmd(Address addr, java.lang.String oldName, java.lang.String newName, SourceType source)	Constructs a new command for renaming global labels.

Method Summary

Modifier and Type	Method	Description
boolean	applyTo(DomainObject obj)	Applies the command to the given domain object.
java.lang.String	getName()	Returns the name of this command.
java.lang.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 Detail

RenameLabelCmd

public RenameLabelCmd(Address addr,
                      java.lang.String oldName,
                      java.lang.String newName,
                      Namespace currentNamespace,
                      SourceType source)

Constructs a new command for renaming a label within a specified namespace.

Parameters:

addr - Address of label to be renamed.

oldName - the current name of the label to be renamed.

newName - the new name for the label. (null for default)

currentNamespace - the symbol's current name space. (The namespace to associate this label with)

source - the source of this symbol

RenameLabelCmd

public RenameLabelCmd(Address addr,
                      java.lang.String oldName,
                      java.lang.String newName,
                      Namespace currentNamespace,
                      Namespace newNamespace,
                      SourceType source)

Constructs a new command for renaming a label within currentNamespace and changing the namespace to newNamespace.

Parameters:

addr - Address of label to be renamed.

oldName - the current name of the label to be renamed.

newName - the new name for the label. (null for default)

currentNamespace - the symbol's current parent name space (null indicates global namespace)

newNamespace - final namespace (null indicates global namespace)

source - the source of this symbol

RenameLabelCmd

public RenameLabelCmd(Address addr,
                      java.lang.String oldName,
                      java.lang.String newName,
                      SourceType source)

Constructs a new command for renaming global labels.

Parameters:

addr - Address of label to be renamed.

oldName - the name of the label to be renamed; may be null of the existing label is a dynamic label

newName - the new name for the label

source - the source of this symbol

Method Detail

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

See Also:

Command.applyTo(ghidra.framework.model.DomainObject)

getName

public java.lang.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

See Also:

Command.getName()

getStatusMsg

public java.lang.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

See Also:

Command.getStatusMsg()