Package ghidra.app.cmd.data

Class AbstractCreateStructureCmd

java.lang.Object

ghidra.app.cmd.data.AbstractCreateStructureCmd

All Implemented Interfaces:

Command<Program>

Direct Known Subclasses:

CreateStructureCmd, CreateStructureInStructureCmd

public abstract class AbstractCreateStructureCmd
extends Object
implements Command<Program>

A base class to hold duplicate information for commands that create structures. This class implements the logic of the applyTo(Program) method so that child implementations need only to implement the abstract methods.

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.
DataType	getNewDataType()	Get the new structure data type which was created.
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

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

getNewDataType

public DataType getNewDataType()

Get the new structure data type which was created.

Returns:

new structure.

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