Package ghidra.app.cmd.function

Class AddParameterCommand

java.lang.Object

ghidra.app.cmd.function.AddParameterCommand

All Implemented Interfaces:

Command

Direct Known Subclasses:

AddMemoryParameterCommand, AddRegisterParameterCommand, AddStackParameterCommand

public class AddParameterCommand
extends java.lang.Object
implements Command

Allows for the adding of a parameter to a given function. Note: If no ordinal is provided to this class at construction time, then the ordinal of hte given parameter will be used.

See Also:

AddRegisterParameterCommand, AddStackParameterCommand

Field Summary

Fields

Modifier and Type	Field	Description
protected Function	function
protected int	ordinal
protected Parameter	parameter
protected SourceType	source
protected java.lang.String	statusMessage

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AddParameterCommand(Function function, int ordinal, SourceType source)
	AddParameterCommand(Function function, Parameter parameter, int ordinal, SourceType source)

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.
protected Parameter	getParameter(Program program)
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

Field Detail

function

protected Function function

parameter

protected Parameter parameter

statusMessage

protected java.lang.String statusMessage

ordinal

protected int ordinal

source

protected SourceType source

Constructor Detail

AddParameterCommand

public AddParameterCommand(Function function,
                           Parameter parameter,
                           int ordinal,
                           SourceType source)

AddParameterCommand

protected AddParameterCommand(Function function,
                              int ordinal,
                              SourceType source)

Method Detail

getParameter

protected Parameter getParameter(Program program)
                          throws InvalidInputException

Throws:

InvalidInputException

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