Package ghidra.app.cmd.comments
Class AppendCommentCmd
- java.lang.Object
-
- ghidra.app.cmd.comments.AppendCommentCmd
-
-
Constructor Summary
Constructors Constructor Description AppendCommentCmd(Address addr, int commentType, java.lang.String comment, java.lang.String separator)Construct command
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanapplyTo(DomainObject obj)Applies the command to the given domain object.java.lang.StringgetName()Returns the name of this command.java.lang.StringgetStatusMsg()Returns the status message indicating the status of the command.
-
-
-
Constructor Detail
-
AppendCommentCmd
public AppendCommentCmd(Address addr, int commentType, java.lang.String comment, java.lang.String separator)
Construct command- Parameters:
addr- address of code unit where comment will be placedcommentType- valid comment type (seeCodeUnit.EOL_COMMENT,CodeUnit.PLATE_COMMENT, etc)comment- comment for code unit, should not be nullseparator- characters to separate the new comment from the previous comment when concatenating.
-
-
Method Detail
-
getName
public java.lang.String getName()
Description copied from interface:CommandReturns the name of this command.- Specified by:
getNamein interfaceCommand- Returns:
- the name of this command
- See Also:
Command.getName()
-
applyTo
public boolean applyTo(DomainObject obj)
Description copied from interface:CommandApplies the command to the given domain object.- Specified by:
applyToin interfaceCommand- 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:CommandReturns the status message indicating the status of the command.- Specified by:
getStatusMsgin interfaceCommand- Returns:
- reason for failure, or null if the status of the command was successful
- See Also:
Command.getStatusMsg()
-
-