Package ghidra.app.cmd.equate

Class SetEquateCmd

  • All Implemented Interfaces:
    Command
    public class SetEquateCmd
extends java.lang.Object
implements Command
    Command for setting an equate at a location.

    • Constructor Summary

      Constructors 
      Constructor Description
      SetEquateCmd​(java.lang.String equateName, Address addr, int opIndex, long equateValue)
      Constructor

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean applyTo​(DomainObject obj)
      Applies the command to the given domain object.
      Equate getEquate()  
      java.lang.String getName()
      The name of the edit action.
      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

      • SetEquateCmd

        public SetEquateCmd​(java.lang.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 Detail

      • getName

        public java.lang.String getName()
        The name of the edit action.
        Specified by:
        getName in interface Command
        Returns:
        the name of this command

      • 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

      • getEquate

        public Equate getEquate()

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