Package graphql.parser

Class CommentParser

java.lang.Object

graphql.parser.CommentParser

public class CommentParser
extends Object

Contains methods for extracting Comment in various positions within and around Nodes

Field Summary

Fields

Modifier and Type	Field	Description
private final Predicate<org.antlr.v4.runtime.Token>	alwaysTrue
private static final int	CHANNEL_COMMENTS
private final Predicate<org.antlr.v4.runtime.Token>	isFirstToken
private final Predicate<org.antlr.v4.runtime.Token>	isNotPrecededByLineBreak
private final Predicate<org.antlr.v4.runtime.Token>	isPrecededByLineBreak
private final Predicate<org.antlr.v4.runtime.Token>	isPrecededOnlyBySpaces
private final Map<Node<?>,org.antlr.v4.runtime.ParserRuleContext>	nodeToRuleMap
private org.antlr.v4.runtime.CommonTokenStream	tokens

Constructor Summary

Constructors

Constructor	Description
CommentParser(NodeToRuleCapturingParser.ParserContext parserContext)

Method Summary

Modifier and Type	Method	Description
Optional<Comment>	getBeginningOfBlockComment(Node<?> node, String prefix)
protected List<Comment>	getCommentOnChannel(List<org.antlr.v4.runtime.Token> refChannel, Predicate<org.antlr.v4.runtime.Token> shouldIncludePredicate)
Optional<Comment>	getCommentOnFirstLineOfDocument(Document node)
List<Comment>	getCommentsAfterAllDefinitions(Document node)
List<Comment>	getCommentsAfterDescription(Node<?> node)
List<Comment>	getEndOfBlockComments(Node<?> node, String blockSuffix)
List<Comment>	getLeadingComments(Node<?> node)
Optional<Comment>	getTrailingComment(Node<?> node)
private Optional<org.antlr.v4.runtime.Token>	searchTokenToLeft(org.antlr.v4.runtime.Token token, String text)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

nodeToRuleMap

private final Map<Node<?>,org.antlr.v4.runtime.ParserRuleContext> nodeToRuleMap

tokens

private org.antlr.v4.runtime.CommonTokenStream tokens

CHANNEL_COMMENTS

private static final int CHANNEL_COMMENTS

See Also:

• Constant Field Values

alwaysTrue

private final Predicate<org.antlr.v4.runtime.Token> alwaysTrue

isNotPrecededByLineBreak

private final Predicate<org.antlr.v4.runtime.Token> isNotPrecededByLineBreak

isPrecededByLineBreak

private final Predicate<org.antlr.v4.runtime.Token> isPrecededByLineBreak

isFirstToken

private final Predicate<org.antlr.v4.runtime.Token> isFirstToken

isPrecededOnlyBySpaces

private final Predicate<org.antlr.v4.runtime.Token> isPrecededOnlyBySpaces

Constructor Details

CommentParser

public CommentParser(NodeToRuleCapturingParser.ParserContext parserContext)

Method Details

getBeginningOfBlockComment

public Optional<Comment> getBeginningOfBlockComment(Node<?> node,
 String prefix)

getEndOfBlockComments

public List<Comment> getEndOfBlockComments(Node<?> node,
 String blockSuffix)

getTrailingComment

public Optional<Comment> getTrailingComment(Node<?> node)

getLeadingComments

public List<Comment> getLeadingComments(Node<?> node)

getCommentsAfterDescription

public List<Comment> getCommentsAfterDescription(Node<?> node)

getCommentOnFirstLineOfDocument

public Optional<Comment> getCommentOnFirstLineOfDocument(Document node)

getCommentsAfterAllDefinitions

public List<Comment> getCommentsAfterAllDefinitions(Document node)

getCommentOnChannel

protected List<Comment> getCommentOnChannel(List<org.antlr.v4.runtime.Token> refChannel,
 Predicate<org.antlr.v4.runtime.Token> shouldIncludePredicate)

searchTokenToLeft

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