Comments (SonarSource :: Cobol :: Javadoc 5.0.0.5433 API)

java.lang.Object
- com.sonar.sslr.api.Comments

All Implemented Interfaces:

Iterable<Token>
```
public class Comments
extends Object
implements Iterable<Token>
```
Utility class to manipulate comment tokens

Constructor Summary

Constructors
Constructor	Description
`Comments(com.google.common.collect.ListMultimap<Integer,Token> comments)`
`Comments(com.google.common.collect.ListMultimap<Integer,Token> comments, CommentAnalyser analyser)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<Token>`	`getCommentTokensAtLine(int line)`
`SortedSet<Integer>`	`getLinesOfComment()`	Get the sorted list of lines containing at least a comment
`boolean`	`hasCommentTokensAtLine(int line)`
`boolean`	`isBlank(String commentValue)`
`Iterator<Token>`	`iterator()`	Iterates over the collection of comment tokens
`int`	`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)
```
  - Comments
```
public Comments(com.google.common.collect.ListMultimap<Integer,Token> comments,
                CommentAnalyser analyser)
```
- Method Detail
  - iterator
```
public Iterator<Token> iterator()
```
    Iterates over the collection of comment tokens
    
    Specified by:
    
    iterator in interface Iterable<Token>
  - 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