Class SetCommentsCmd

  • All Implemented Interfaces:
    Command

    public class SetCommentsCmd
    extends java.lang.Object
    implements Command
    Command for editing and removing comments at an address.
    • Constructor Summary

      Constructors 
      Constructor Description
      SetCommentsCmd​(Address addr, java.lang.String newPreComment, java.lang.String newPostComment, java.lang.String newEolComment, java.lang.String newPlateComment, java.lang.String newRepeatableComment)
      Construct command for setting all the different types of comments at an address.
    • 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()
      The name of the edit action.
      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

      • SetCommentsCmd

        public SetCommentsCmd​(Address addr,
                              java.lang.String newPreComment,
                              java.lang.String newPostComment,
                              java.lang.String newEolComment,
                              java.lang.String newPlateComment,
                              java.lang.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 Detail

      • getName

        public java.lang.String getName()
        The name of the edit action.
        Specified by:
        getName in interface Command
        Returns:
        the name of this command
      • 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()