Package ghidra.app.cmd.label

Class SetLabelPrimaryCmd

java.lang.Object

ghidra.app.cmd.label.SetLabelPrimaryCmd

All Implemented Interfaces:

Command

public class SetLabelPrimaryCmd
extends java.lang.Object
implements Command

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, java.lang.String name, Namespace scope)	Constructs a new command for setting the primary state of a label.

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

SetLabelPrimaryCmd

public SetLabelPrimaryCmd(Address addr,
                          java.lang.String name,
                          Namespace scope)

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.

scope - the scope of the label to make primary. (the namespace that the label is associated with)

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)

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()

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()