Class SetExternalNameCmd

java.lang.Object

ghidra.app.cmd.refs.SetExternalNameCmd

All Implemented Interfaces:

Command<Program>

public class SetExternalNameCmd
extends Object
implements Command<Program>

Command for setting the external program name and path.

Constructor Summary

Constructors

Change	Constructor	Description
	SetExternalNameCmd(String externalName, String externalPath)	Constructs a new command for creating a Library, if it does not exist, and optionally setting the associated external program path.
	SetExternalNameCmd(String externalName, String externalPath, SourceType source)	Constructs a new command for creating a Library, if it does not exist, and optionally setting the associated external program path.

Method Summary

Change	Modifier and Type	Method	Description
	boolean	applyTo(Program program)	Applies the command to the given domain object.
	String	getName()	Returns the name of this command.
	String	getStatusMsg()	Returns the status message indicating the status of the command.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SetExternalNameCmd

public SetExternalNameCmd(String externalName,
 String externalPath)

Constructs a new command for creating a Library, if it does not exist, and optionally setting the associated external program path. If created, a SourceType.USER_DEFINED source will be specified.

Parameters:

externalName - the Library name.

externalPath - the project file path of the program file to associate with the Library.

SetExternalNameCmd

public SetExternalNameCmd(String externalName,
 String externalPath,
 SourceType source)

Constructs a new command for creating a Library, if it does not exist, and optionally setting the associated external program path.

Parameters:

externalName - the Library name.

externalPath - the project file path of the program file to associate with the Library.

source - the symbol source type to be applied if the library must be created.

Method Details

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

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

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