Package ghidra.app.cmd.comments

Class SetCommentsCmd

java.lang.Object

ghidra.app.cmd.comments.SetCommentsCmd

All Implemented Interfaces:

Command<Program>

public class SetCommentsCmd
extends Object
implements Command<Program>

Command for editing and removing comments at an address.

Constructor Summary

Constructors

Constructor	Description
SetCommentsCmd(Address addr, String newPreComment, String newPostComment, String newEolComment, String newPlateComment, String newRepeatableComment)	Construct command for setting all the different types of comments at an address.

Method Summary

Modifier and Type	Method	Description
boolean	applyTo(Program program)	Applies the command to the given domain object.
String	getName()	The name of the edit action.
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

SetCommentsCmd

public SetCommentsCmd(Address addr,
 String newPreComment,
 String newPostComment,
 String newEolComment,
 String newPlateComment,
 String newRepeatableComment)

Construct command for setting all the different types of comments at an address.

Parameters:

addr - address of code unit where comment will edited

newPreComment - new pre comment

newPostComment - new post comment

newEolComment - new eol comment

newPlateComment - new plate comment

newRepeatableComment - new repeatable comment

Method Details

getName

public String getName()

The name of the edit action.

Specified by:

getName in interface Command<Program>

Returns:

the name of this command

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