Class RebaseTodoLine


  • public class RebaseTodoLine
    extends Object
    Describes a single line in a file formatted like the git-rebase-todo file.
    Since:
    3.2
    • Constructor Detail

      • RebaseTodoLine

        public RebaseTodoLine​(String newComment)
        Create a new comment line
        Parameters:
        newComment - the new comment
    • Method Detail

      • setAction

        public void setAction​(RebaseTodoLine.Action newAction)
                       throws IllegalTodoFileModification
        Set the action. It's not allowed to set a non-comment action on a line which was a comment line before. But you are allowed to set the comment action on a non-comment line and afterwards change the action back to non-comment.
        Parameters:
        newAction -
        Throws:
        IllegalTodoFileModification - on attempt to set a non-comment action on a line which was a comment line before.
      • setComment

        public void setComment​(String newComment)

        Set a comment for this line that is used if this line's action is a RebaseTodoLine.Action.COMMENT

        It's allowed to unset the comment by calling setComment(null)
        A valid comment either starts with a hash (i.e. '#'), is an empty string, or consists of only spaces and tabs.
        If the argument newComment doesn't match these requirements an Exception is thrown.
        Parameters:
        newComment - the comment
      • getCommit

        public AbbreviatedObjectId getCommit()
        Returns:
        abbreviated commit SHA-1 of commit that action will be performed on
      • getShortMessage

        public String getShortMessage()
        Returns:
        the first line of the commit message of the commit the action will be performed on.
      • setShortMessage

        public void setShortMessage​(String shortMessage)
        Parameters:
        shortMessage -
      • getComment

        public String getComment()
        Returns:
        a comment. If the line is a comment line then the comment is returned. Lines starting with # or blank lines or lines containing only spaces and tabs are considered as comment lines. The complete line is returned (e.g. including the '#')