org.panda_lang.framework.language.interpreter.token

Class SynchronizedSource

java.lang.Object

org.panda_lang.framework.language.interpreter.token.SynchronizedSource

All Implemented Interfaces:

Iterable<TokenInfo>, Iterator<TokenInfo>, Streamable

public final class SynchronizedSource
extends Object
implements Iterable<TokenInfo>, Iterator<TokenInfo>, Streamable

SynchronizedSource works like a shared iterator with its own index and source based on Snippet

Constructor Summary

Constructors

Constructor and Description
SynchronizedSource(Snippet source)

Method Summary

Modifier and Type	Method and Description
void	cacheIndex() Backup the current index
int	getAmountOfAvailableSource() Get amount of source that is available to read
Snippet	getAvailableSource() Get available source to read as snippet
int	getCachedIndex() Get cached index
Optional<TokenInfo>	getCurrent() Get current token
int	getIndex() Get current index
Snippet	getLastReadSource() Get source that has been read since the last backup
TokenInfo	getNext() Get next token without updating index
@Nullable TokenInfo	getPrevious() Get previous token
@Nullable TokenInfo	getPrevious(int previous) Get previous token
Snippet	getSource() The original source used to create SynchronizedSource
boolean	hasNext() Check if source has available next token
Iterator<TokenInfo>	iterator()
TokenInfo	next() Read the next token and move index
void	next(int amount) Read the given amount of tokens
void	setIndex(int index) Set current index of source
SourceStream	toStream() Convert object to the source stream

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

SynchronizedSource

public SynchronizedSource(Snippet source)

Method Detail

cacheIndex

public void cacheIndex()

Backup the current index

iterator

public Iterator<TokenInfo> iterator()

Specified by:

iterator in interface Iterable<TokenInfo>

next

public TokenInfo next()

Read the next token and move index

Specified by:

next in interface Iterator<TokenInfo>

Returns:

the next token

See Also:

hasNext()

next

public void next(int amount)

Read the given amount of tokens

Parameters:

amount - the amount to read

hasNext

public boolean hasNext()

Check if source has available next token

Specified by:

hasNext in interface Iterator<TokenInfo>

Returns:

true if there is token to read

setIndex

public void setIndex(int index)

Set current index of source

Parameters:

index - the index to set

getPrevious

@Nullable
public @Nullable TokenInfo getPrevious()

Get previous token

Returns:

the previous token or null if index is 0

See Also:

getPrevious(int)

getPrevious

@Nullable
public @Nullable TokenInfo getPrevious(int previous)

Get previous token

Parameters:

previous - amount of previous tokens to skip (by default 0 - returns previous token)

Returns:

requested token or if it's out of index - null

getCurrent

public Optional<TokenInfo> getCurrent()

Get current token

Returns:

the current token

getNext

public TokenInfo getNext()

Get next token without updating index

Returns:

the next token

getLastReadSource

public Snippet getLastReadSource()

Get source that has been read since the last backup

Returns:

the last read source

getAvailableSource

public Snippet getAvailableSource()

Get available source to read as snippet

Returns:

the snippet with available to read source

getAmountOfAvailableSource

public int getAmountOfAvailableSource()

Get amount of source that is available to read

Returns:

the amount of source

getCachedIndex

public int getCachedIndex()

Get cached index

Returns:

the cached index

getIndex

public int getIndex()

Get current index

Returns:

the current index

getSource

public Snippet getSource()

The original source used to create SynchronizedSource

Returns:

the original source

toStream

public SourceStream toStream()

Description copied from interface: Streamable

Convert object to the source stream

Specified by:

toStream in interface Streamable

Returns:

the source stream