org.panda_lang.framework.design.interpreter.token

Interface TokenInfo

All Superinterfaces:

Snippetable, Streamable, Token

All Known Implementing Classes:

MutableTokenInfo, PandaTokenInfo

public interface TokenInfo
extends Token, Snippetable

Wrapper for Token that contains details about location of token in source

Method Summary

Modifier and Type	Method and Description
default boolean	contentEquals(Token token) Compare wrapped token with another token, utility method
Location	getLocation() Get location of token
default Optional<String>	getName() Get custom name of the token
Token	getToken() Get the wrapped token
default TokenType	getType() Get type of the token represented by TokenType
default String	getValue() Get value of the token
default boolean	hasName() Check if the token has custom name
default Snippet	toSnippet() Converts current object into the Snippet
default <T extends Token> T	toToken() Get token using getToken() method and cast it to the requested type
default <T extends Token> T	toToken(Class<T> type) Get token using getToken() method and cast it to the requested type

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

equals

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

toStream

Method Detail

contentEquals

default boolean contentEquals(Token token)

Compare wrapped token with another token, utility method

Parameters:

token - the token to compare with

Returns:

true if tokens are equal

getToken

Token getToken()

Get the wrapped token

Returns:

the original token

getLocation

Location getLocation()

Get location of token

Returns:

the location

toToken

default <T extends Token> T toToken(Class<T> type)

Get token using getToken() method and cast it to the requested type

Type Parameters:

T - the type to cast

Parameters:

type - the class type

Returns:

casted value, otherwise ClassCastException

toToken

default <T extends Token> T toToken()

Get token using getToken() method and cast it to the requested type

Type Parameters:

T - the type to cast

Returns:

casted value, otherwise ClassCastException

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

hasName

default boolean hasName()

Description copied from interface: Token

Check if the token has custom name

Specified by:

hasName in interface Token

Returns:

true if token contains name

getName

default Optional<String> getName()

Description copied from interface: Token

Get custom name of the token

Specified by:

getName in interface Token

Returns:

optional that may contain custom name of token

getValue

default String getValue()

Description copied from interface: Token

Get value of the token

Specified by:

getValue in interface Token

Returns:

the value

getType

default TokenType getType()

Description copied from interface: Token

Get type of the token represented by TokenType

Specified by:

getType in interface Token

Returns:

the type of the token