SourceStream (panda-framework indev-20.5.5 API)

All Superinterfaces:

Snippetable, Streamable

All Known Implementing Classes:

PandaSourceStream
```
public interface SourceStream
extends Snippetable
```
Represents stream of tokens

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`dispose(int length)` Read the specified amount of tokens and dispose result (it won't create snippet)
`TokenInfo`	`getCurrent()` Get current token
`default int`	`getCurrentLine()` Get current line
`Snippet`	`getOriginalSource()` Get original source used to create the stream
`default int`	`getReadLength()` Get the amount of read tokens
`default int`	`getUnreadLength()` Get the amount of unread tokens
`boolean`	`hasUnreadSource()` Check if the source has available content
`TokenInfo`	`read()` Read the next token
`Snippet`	`read(int length)` Read the specified amount of tokens
`Snippet`	`readLineResidue()` Read the rest of the current line
`Snippet`	`toSnippet()` Get current source as snippet
`default SourceStream`	`toStream()` Convert object to the source stream

- Method Detail
  - read
```
TokenInfo read()
```
    Read the next token
    
    Returns:
    
    the next token
  - read
```
Snippet read(int length)
```
    Read the specified amount of tokens
    
    Parameters:
    
    length - amount of tokens to read
    
    Returns:
    
    the read tokens
  - dispose
```
void dispose(int length)
```
    Read the specified amount of tokens and dispose result (it won't create snippet)
  - readLineResidue
```
Snippet readLineResidue()
```
    Read the rest of the current line
    
    Returns:
    
    the rest of the source at the current line
  - hasUnreadSource
```
boolean hasUnreadSource()
```
    Check if the source has available content
    
    Returns:
    
    true if source contains available for read content
  - getCurrent
```
TokenInfo getCurrent()
```
    Get current token
    
    Returns:
    
    current token
  - getOriginalSource
```
Snippet getOriginalSource()
```
    Get original source used to create the stream
    
    Returns:
    
    the original source
  - getCurrentLine
```
default int getCurrentLine()
```
    Get current line
    
    Returns:
    
    if there is no available source, the method returns -2, otherwise returns the number of current line
  - getReadLength
```
default int getReadLength()
```
    Get the amount of read tokens
    
    Returns:
    
    the amount of read tokens
  - getUnreadLength
```
default int getUnreadLength()
```
    Get the amount of unread tokens
    
    Returns:
    
    the amount of unread tokens
  - toSnippet
```
Snippet toSnippet()
```
    Get current source as snippet
    
    Specified by:
    
    toSnippet in interface Snippetable
    
    Returns:
    
    the current content wrapped in snippet
  - toStream
```
default SourceStream toStream()
```
    Description copied from interface: Streamable
    
    Convert object to the source stream
    
    Specified by:
    
    toStream in interface Snippetable
    
    Specified by:
    
    toStream in interface Streamable
    
    Returns:
    
    the source stream

Interface SourceStream

Method Summary

Method Detail

read

read

dispose

readLineResidue

hasUnreadSource

getCurrent

getOriginalSource

getCurrentLine

getReadLength

getUnreadLength

toSnippet

toStream