Class CommentParser


  • public class CommentParser
    extends java.lang.Object
    Contains methods for extracting Comment in various positions within and around Nodes
    • Field Detail

      • nodeToRuleMap

        private final java.util.Map<Node<?>,​org.antlr.v4.runtime.ParserRuleContext> nodeToRuleMap
      • tokens

        private org.antlr.v4.runtime.CommonTokenStream tokens
      • alwaysTrue

        private final java.util.function.Predicate<org.antlr.v4.runtime.Token> alwaysTrue
      • isNotPrecededByLineBreak

        private final java.util.function.Predicate<org.antlr.v4.runtime.Token> isNotPrecededByLineBreak
      • isPrecededByLineBreak

        private final java.util.function.Predicate<org.antlr.v4.runtime.Token> isPrecededByLineBreak
      • isFirstToken

        private final java.util.function.Predicate<org.antlr.v4.runtime.Token> isFirstToken
      • isPrecededOnlyBySpaces

        private final java.util.function.Predicate<org.antlr.v4.runtime.Token> isPrecededOnlyBySpaces
    • Method Detail

      • getBeginningOfBlockComment

        public java.util.Optional<Comment> getBeginningOfBlockComment​(Node<?> node,
                                                                      java.lang.String prefix)
      • getEndOfBlockComments

        public java.util.List<Comment> getEndOfBlockComments​(Node<?> node,
                                                             java.lang.String blockSuffix)
      • getTrailingComment

        public java.util.Optional<Comment> getTrailingComment​(Node<?> node)
      • getLeadingComments

        public java.util.List<Comment> getLeadingComments​(Node<?> node)
      • getCommentsAfterDescription

        public java.util.List<Comment> getCommentsAfterDescription​(Node<?> node)
      • getCommentOnFirstLineOfDocument

        public java.util.Optional<Comment> getCommentOnFirstLineOfDocument​(Document node)
      • getCommentsAfterAllDefinitions

        public java.util.List<Comment> getCommentsAfterAllDefinitions​(Document node)
      • getCommentOnChannel

        protected java.util.List<Comment> getCommentOnChannel​(java.util.List<org.antlr.v4.runtime.Token> refChannel,
                                                              java.util.function.Predicate<org.antlr.v4.runtime.Token> shouldIncludePredicate)
      • searchTokenToLeft

        private java.util.Optional<org.antlr.v4.runtime.Token> searchTokenToLeft​(org.antlr.v4.runtime.Token token,
                                                                                 java.lang.String text)