Class AppendCommentCmd

  • All Implemented Interfaces:
    Command

    public class AppendCommentCmd
    extends java.lang.Object
    implements Command
    Command to append a specific type of comment on a code unit.
    • 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
      boolean applyTo​(DomainObject obj)
      Applies the command to the given domain object.
      java.lang.String getName()
      Returns the name of this command.
      java.lang.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 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 placed
        commentType - valid comment type (see CodeUnit.EOL_COMMENT, CodeUnit.PLATE_COMMENT, etc)
        comment - comment for code unit, should not be null
        separator - characters to separate the new comment from the previous comment when concatenating.
    • Method Detail

      • getName

        public java.lang.String getName()
        Description copied from interface: Command
        Returns the name of this command.
        Specified by:
        getName in interface Command
        Returns:
        the name of this command
        See Also:
        Command.getName()
      • getStatusMsg

        public java.lang.String getStatusMsg()
        Description copied from interface: Command
        Returns the status message indicating the status of the command.
        Specified by:
        getStatusMsg in interface Command
        Returns:
        reason for failure, or null if the status of the command was successful
        See Also:
        Command.getStatusMsg()