Package ghidra.app.cmd.label

Class AddLabelCmd

java.lang.Object

ghidra.app.cmd.label.AddLabelCmd

All Implemented Interfaces:

Command<Program>

public class AddLabelCmd
extends Object
implements Command<Program>

Command to add a label.

Constructor Summary

Constructors

Constructor	Description
AddLabelCmd(Address addr, String name, boolean useLocalNamespace, SourceType source)	Constructs a new command for adding a label.
AddLabelCmd(Address addr, String name, Namespace namespace, SourceType source)	Constructs a new command for adding a label.
AddLabelCmd(Address addr, String name, SourceType source)	Constructs a new command for adding a label.

Method Summary

Modifier and Type	Method	Description
boolean	applyTo(Program program)	Applies the command to the given domain object.
Address	getLabelAddr()
String	getLabelName()
String	getName()	Returns the name of this command.
String	getStatusMsg()	Returns the status message indicating the status of the command.
Symbol	getSymbol()
void	setLabelAddr(Address addr)
void	setLabelName(String name)
void	setNamespace(Namespace namespace)

Methods inherited from class java.lang.Object

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

Constructor Details

AddLabelCmd

public AddLabelCmd(Address addr,
 String name,
 Namespace namespace,
 SourceType source)

Constructs a new command for adding a label.

Parameters:

addr - address where the label is to be added.

name - name of the new label. A null name will cause a default label be added.

namespace - the namespace of the label. (i.e. the namespace this label is associated with)

source - the source of this symbol

AddLabelCmd

public AddLabelCmd(Address addr,
 String name,
 boolean useLocalNamespace,
 SourceType source)

Constructs a new command for adding a label.

Parameters:

addr - address where the label is to be added.

name - name of the new label. A null name will cause a default label be added.

useLocalNamespace - If true, the namespace will be that of the lowest level namespace for the indicated address. If false, the global namespace is used for the namespace.

source - the source of this symbol: Symbol.DEFAULT, Symbol.IMPORTED, Symbol.ANALYSIS, or Symbol.USER_DEFINED.

AddLabelCmd

public AddLabelCmd(Address addr,
 String name,
 SourceType source)

Constructs a new command for adding a label.

Parameters:

addr - address where the label is to be added.

name - name of the new label. A null name will cause a default label be added.

source - the source of this symbol

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

getLabelName

public String getLabelName()

getLabelAddr

public Address getLabelAddr()

setLabelAddr

public void setLabelAddr(Address addr)

setLabelName

public void setLabelName(String name)

setNamespace

public void setNamespace(Namespace namespace)

getSymbol

public Symbol getSymbol()