de.weltraumschaf.commons.token

Interface Token

All Known Implementing Classes:

BaseToken, BaseToken.BooleanToken, BaseToken.FloatToken, BaseToken.IntegerToken, BaseToken.KeywordToken, BaseToken.LiteralToken, BaseToken.StringToken

public interface Token

Defines a token.

Since:

1.0.0

Author:

Sven Strittmatter

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	asBoolean() Get the boolean typed value.
Float	asFloat() Get the float typed value.
Integer	asInteger() Get the integer typed value.
String	asString() Get the string typed value.
Position	getPosition() Start position of the token.
String	getRaw() The raw string recognized by the scanner.
TokenType	getType() Get the token type class.

Method Detail

getPosition

Position getPosition()

Start position of the token.

Returns:

never null

getRaw

String getRaw()

The raw string recognized by the scanner.

For example a string token "foo" has the raw value "foo" in contrast it's typed string value will be foo.

Returns:

never null

getType

TokenType getType()

Get the token type class.

Returns:

never null

asBoolean

Boolean asBoolean()

Get the boolean typed value.

This method throws UnsupportedOperationException if the token's token class is not of type TokenType.BOOLEAN.

Returns:

never null

asFloat

Float asFloat()

Get the float typed value.

This method throws UnsupportedOperationException if the token's token class is not of type TokenType.FLOAT.

Returns:

never null

asInteger

Integer asInteger()

Get the integer typed value.

This method throws UnsupportedOperationException if the token's token class is not of type TokenType.INTEGER.

Returns:

never null

asString

String asString()

Get the string typed value.

This method never throws UnsupportedOperationException. It always calls Object.toString() on the recognized typed value.

Returns:

never null