Package ghidra.app.cmd.refs

Class RemoveAllReferencesCmd

java.lang.Object

ghidra.app.cmd.refs.RemoveAllReferencesCmd

All Implemented Interfaces:

Command

public class RemoveAllReferencesCmd
extends java.lang.Object
implements Command

Command to remove all references at an address or for a particular operand index at an address.

Constructor Summary

Constructors

Constructor	Description
RemoveAllReferencesCmd(Address fromAddr)	Constructs a new command for removing all references.
RemoveAllReferencesCmd(Address fromAddr, int opIndex)	Constructs a new command for removing all references.

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

RemoveAllReferencesCmd

public RemoveAllReferencesCmd(Address fromAddr)

Constructs a new command for removing all references.

Parameters:

fromAddr - the address of the codeunit making the reference.

RemoveAllReferencesCmd

public RemoveAllReferencesCmd(Address fromAddr,
                              int opIndex)

Constructs a new command for removing all references.

Parameters:

fromAddr - the address of the codeunit making the reference.

opIndex - the operand index.

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