Package ghidra.app.cmd.equate

Class SetEquateCmd

java.lang.Object

ghidra.app.cmd.equate.SetEquateCmd

All Implemented Interfaces:

Command<Program>

public class SetEquateCmd
extends Object
implements Command<Program>

Command for setting an equate at a location.

Constructor Summary

Constructors

Constructor	Description
SetEquateCmd(String equateName, Address addr, int opIndex, long equateValue)	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	applyTo(Program program)	Applies the command to the given domain object.
Equate	getEquate()
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

SetEquateCmd

public SetEquateCmd(String equateName,
 Address addr,
 int opIndex,
 long equateValue)

Constructor

Parameters:

equateName - the name of the equate to applied or removed at this location.

addr - the address of the current location.

opIndex - the operand index of the current location.

equateValue - the numeric value at the current location.

Method Details

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

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

getEquate

public Equate getEquate()

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