Class CommentLine


  • public class CommentLine
    extends java.lang.Object
    A comment line. Maybe a block comment, blank line, or inline comment.
    • Field Detail

      • startMark

        private final java.util.Optional<Mark> startMark
      • endMark

        private final java.util.Optional<Mark> endMark
      • value

        private final java.lang.String value
    • Constructor Detail

      • CommentLine

        public CommentLine​(CommentEvent event)
        Create
        Parameters:
        event - - the source
      • CommentLine

        public CommentLine​(java.util.Optional<Mark> startMark,
                           java.util.Optional<Mark> endMark,
                           java.lang.String value,
                           CommentType commentType)
        Create
        Parameters:
        startMark - - start
        endMark - - end
        value - - the comment
        commentType - - the type
    • Method Detail

      • getEndMark

        public java.util.Optional<Mark> getEndMark()
        getter
        Returns:
        end position
      • getStartMark

        public java.util.Optional<Mark> getStartMark()
        getter
        Returns:
        start position
      • getCommentType

        public CommentType getCommentType()
        getter
        Returns:
        type of it
      • getValue

        public java.lang.String getValue()
        Value of this comment.
        Returns:
        comment's value.
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object