Package ghidra.app.cmd.label

Class SetLabelPrimaryCmd

java.lang.Object

ghidra.app.cmd.label.SetLabelPrimaryCmd

All Implemented Interfaces:

Command<Program>

public class SetLabelPrimaryCmd
extends Object
implements Command<Program>

Command to make a label the primary label at an address. Only really makes sense if there is more than one label at the address - otherwise the label will already be primary.

Constructor Summary

Constructors

Constructor	Description
SetLabelPrimaryCmd(Address addr, String name, Namespace namespace)	Constructs a new command for setting the primary state of a label.

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.
Symbol	getSymbol()	Get transformed symbol

Methods inherited from class java.lang.Object

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

Constructor Details

SetLabelPrimaryCmd

public SetLabelPrimaryCmd(Address addr,
 String name,
 Namespace namespace)

Constructs a new command for setting the primary state of a label.

Parameters:

addr - the address of the label to make primary.

name - the name of the label to make primary.

namespace - the parent namespace of the label to make primary.

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

getSymbol

public Symbol getSymbol()

Get transformed symbol

Returns:

symbol (may be null if command did not execute successfully)