Package ghidra.app.cmd.data

Class CreateArrayCmd

java.lang.Object

ghidra.app.cmd.data.CreateArrayCmd

All Implemented Interfaces:

Command<Program>

public class CreateArrayCmd
extends Object
implements Command<Program>

Command to create an array. All conflicting data will be cleared.

Constructor Summary

Constructors

Constructor	Description
CreateArrayCmd(Address addr, int numElements, DataType dt, int elementLength)	Constructs a new command for creating arrays.

Method Summary

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 java.lang.Object

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

Constructor Details

CreateArrayCmd

public CreateArrayCmd(Address addr,
 int numElements,
 DataType dt,
 int elementLength)

Constructs a new command for creating arrays.

Parameters:

addr - The address at which to create an array.

numElements - the number of elements in the array to be created. A 0 element count is permitted but a minimum length will apply for all array instances.

dt - the dataType of the elements in the array to be created.

elementLength - the size of an element in the array. Only used for Dynamic datatype dt when Dynamic.canSpecifyLength() returns true.

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