Snippet (panda-framework indev-20.5.18 API)

All Superinterfaces:

Iterable<TokenInfo>, Snippetable, Streamable

All Known Implementing Classes:

PandaSnippet
```
public interface Snippet
extends Iterable<TokenInfo>, Snippetable
```
Snippet is one of the most basic structures used by the Panda Framework. It may be also called syntax tree.

Field Summary

Fields
Modifier and Type Field and Description

static int NOT_FOUND
Constant for not found result

Fields
Modifier and Type	Field and Description
`static int`	`NOT_FOUND` Constant for not found result

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`addToken(TokenInfo tokenInfo)` Add token to the snippet
`void`	`addTokens(Snippet snippet)` Add tokens to the current snippet
`default String`	`asSource()` Get snippet as source.
`default boolean`	`contains(Token... tokens)` Check if snippet contains at least one of the given token
`default TokenInfo`	`get(int index)` Get token at the given position
`default TokenInfo`	`getFirst()` Get the first token
`default TokenInfo`	`getLast()` Get the last token
`default @Nullable TokenInfo`	`getLast(int lastIndex)` Get token at the given index counting backwards of snippet
`default Snippet`	`getLine(int line)` Get tokens at the given line as a snippet
`default Location`	`getLocation()` Get `Location` of first token in snippet
`List<? extends TokenInfo>`	`getTokensRepresentations()` Get tokens as list
`default boolean`	`hasElement(int index)` Check if snippet contains token at the given index
`default int`	`indexOf(Token token)` Get index of the given token in snippet
`default boolean`	`isEmpty()` Check if snippet is empty
`default Iterator<TokenInfo>`	`iterator()` Snippet supports iterations
`default TokenInfo`	`remove(int index)` Remove token at the given index
`default void`	`removeToken(TokenInfo tokenInfo)` Remove token from snippet
`default Snippet`	`reversed()` Reverse tokens and get'em as a new snippet
`default int`	`size()` Get size of snippet
`default Snippet[]`	`split(Token delimiter)` Split snippet using the given delimiter.
`default boolean`	`startsWith(Token... tokens)` Check if snippet starts with the given tokens
`default Snippet`	`subSource(int fromIndex, int toIndex)` Returns a view of the portion of this snippet between the specified fromIndex, inclusive, and toIndex exclusive.
`TokenInfo[]`	`toArray()` Convert snippet into the array of tokens
`default Snippet`	`toSnippet()` Converts current object into the `Snippet`

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface org.panda_lang.framework.design.interpreter.token.Snippetable
toStream

- Field Detail
  - NOT_FOUND
```
static final int NOT_FOUND
```
    Constant for not found result
    
    See Also:
    
    Constant Field Values
- Method Detail
  - iterator
```
default Iterator<TokenInfo> iterator()
```
    Snippet supports iterations
    
    Specified by:
    
    iterator in interface Iterable<TokenInfo>
    
    Returns:
    
    the iterator
  - reversed
```
default Snippet reversed()
```
    Reverse tokens and get'em as a new snippet
    
    Returns:
    
    a reversed snippet
  - subSource
```
default Snippet subSource(int fromIndex,
                          int toIndex)
```
    Returns a view of the portion of this snippet between the specified fromIndex, inclusive, and toIndex exclusive. Returned snipped is an independent element and changes in sub snippet does not affect the original snippet.
    
    Parameters:
    
    fromIndex - the start index
    
    toIndex - the end index
    
    Returns:
    
    a new snippet
  - split
```
default Snippet[] split(Token delimiter)
```
    Split snippet using the given delimiter. If snippet does not contain delimiter, the method will return one item array containing copy of the current source
    
    Parameters:
    
    delimiter - the delimiting token
    
    Returns:
    
    array of items
  - startsWith
```
default boolean startsWith(Token... tokens)
```
    Check if snippet starts with the given tokens
    
    Parameters:
    
    tokens - the tokens to compare with
    
    Returns:
    
    true if snippet starts with the given tokens, otherwise false
  - contains
```
default boolean contains(Token... tokens)
```
    Check if snippet contains at least one of the given token
    
    Parameters:
    
    tokens - the tokens to search for
    
    Returns:
    
    true if snippet contains the given token, otherwise false
  - indexOf
```
default int indexOf(Token token)
```
    Get index of the given token in snippet
    
    Parameters:
    
    token - the token to search for
    
    Returns:
    
    index of token, if snippet does not contain token, the method returns NOT_FOUND value
  - addTokens
```
void addTokens(Snippet snippet)
```
    Add tokens to the current snippet
    
    Parameters:
    
    snippet - the snippet (collection of tokens) to add
  - addToken
```
void addToken(TokenInfo tokenInfo)
```
    Add token to the snippet
    
    Parameters:
    
    tokenInfo - the token to add
  - removeToken
```
default void removeToken(TokenInfo tokenInfo)
```
    Remove token from snippet
    
    Parameters:
    
    tokenInfo - the token to remove
  - remove
```
default TokenInfo remove(int index)
```
    Remove token at the given index
    
    Parameters:
    
    index - the index to use
    
    Returns:
    
    removed token
  - size
```
default int size()
```
    Get size of snippet
    
    Returns:
    
    amount of tokens in the snippet
  - isEmpty
```
default boolean isEmpty()
```
    Check if snippet is empty
    
    Returns:
    
    true if snippet does not contain any token
  - hasElement
```
default boolean hasElement(int index)
```
    Check if snippet contains token at the given index
    
    Parameters:
    
    index - the index to check
    
    Returns:
    
    true if there is token at the given index
  - get
```
default TokenInfo get(int index)
```
    Get token at the given position
    
    Parameters:
    
    index - the index to use
    
    Returns:
    
    a token at the given position
    
    Throws:
    
    SnippetIndexOutOfBoundsException - when index is out of bounds
  - getFirst
```
default TokenInfo getFirst()
```
    Get the first token
    
    Returns:
    
    the first token
  - getLast
```
@Nullable
default @Nullable TokenInfo getLast(int lastIndex)
```
    Get token at the given index counting backwards of snippet
    
    Parameters:
    
    lastIndex - the index to use
    
    Returns:
    
    token at the given position, otherwise null
  - getLast
```
default TokenInfo getLast()
```
    Get the last token
    
    Returns:
    
    the last token or null if the snippet is empty
  - getLine
```
default Snippet getLine(int line)
```
    Get tokens at the given line as a snippet
    
    Parameters:
    
    line - the line to search for
    
    Returns:
    
    tokens at the requested line
  - getLocation
```
default Location getLocation()
```
    Get Location of first token in snippet
    
    Returns:
    
    the current location
  - asSource
```
default String asSource()
```
    Get snippet as source. Method toString() returns an easy to read formatted representation of snippet, but the current method returns the source represented by snippet that may be still parsed.
    
    Returns:
    
    the source represented by the snippet
  - getTokensRepresentations
```
List<? extends TokenInfo> getTokensRepresentations()
```
    Get tokens as list
    
    Returns:
    
    the list of tokens used by snippet
  - toArray
```
TokenInfo[] toArray()
```
    Convert snippet into the array of tokens
    
    Returns:
    
    a new array containing content of snippet
  - toSnippet
```
default Snippet toSnippet()
```
    Description copied from interface: Snippetable
    
    Converts current object into the Snippet
    
    Specified by:
    
    toSnippet in interface Snippetable
    
    Returns:
    
    a new snippet containing content of the current object

Interface Snippet

Field Summary

Method Summary

Methods inherited from interface java.lang.Iterable

Methods inherited from interface org.panda_lang.framework.design.interpreter.token.Snippetable

Field Detail

NOT_FOUND

Method Detail

iterator

reversed

subSource

split

startsWith

contains

indexOf

addTokens

addToken

removeToken

remove

size

isEmpty

hasElement

get

getFirst

getLast

getLast

getLine

getLocation

asSource

getTokensRepresentations

toArray

toSnippet