Package com.sonar.sslr.api
Class Comments
- java.lang.Object
-
- com.sonar.sslr.api.Comments
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Token
getCommentAtLine(int line)
Deprecated.List<Token>
getCommentTokensAtLine(int line)
SortedSet<Integer>
getLinesOfComment()
Get the sorted list of lines containing at least a commentboolean
hasCommentTokensAtLine(int line)
boolean
isBlank(String commentValue)
boolean
isBlankComment(int line)
Deprecated.see#isBlank(int)
static boolean
isBlankComment(String comment)
Deprecated.seeisBlank(String)
boolean
isThereCommentAtLine(int commentLine)
Deprecated.boolean
isThereCommentBeforeLine(int line)
Deprecated.since 1.13 use trivia insteadIterator<Token>
iterator()
Iterates over the collection of comment tokensint
size()
Return the number of comment tokens-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
-
-
-
Constructor Detail
-
Comments
public Comments(com.google.common.collect.ListMultimap<Integer,Token> comments, CommentAnalyser analyser)
-
-
Method Detail
-
getLinesOfComment
public SortedSet<Integer> getLinesOfComment()
Get the sorted list of lines containing at least a comment
-
size
public int size()
Return the number of comment tokens
-
hasCommentTokensAtLine
public boolean hasCommentTokensAtLine(int line)
- Parameters:
line
- the line where we expect to find some comment tokens- Returns:
- true if there is at least one comment token at provided line
-
getCommentTokensAtLine
public List<Token> getCommentTokensAtLine(int line)
- Parameters:
line
- the line where we expect to find some comment tokens- Returns:
- the list of comment tokens on this line
-
isBlank
public boolean isBlank(String commentValue)
- Parameters:
commentValue
- the value of the comment- Returns:
- true if the value is considered to be a blank comment
-
isBlankComment
@Deprecated public static boolean isBlankComment(String comment)
Deprecated.seeisBlank(String)
-
isBlankComment
@Deprecated public boolean isBlankComment(int line)
Deprecated.see#isBlank(int)
-
getCommentAtLine
@Deprecated public Token getCommentAtLine(int line)
Deprecated.
-
isThereCommentBeforeLine
public boolean isThereCommentBeforeLine(int line)
Deprecated.since 1.13 use trivia instead- Parameters:
line
- the line above which some non-blank comment tokens are expected to be found- Returns:
- true if there is a list one non-blank comment tokens before the provided line
-
isThereCommentAtLine
@Deprecated public boolean isThereCommentAtLine(int commentLine)
Deprecated.
-
-