de.weltraumschaf.commons.token

Class BaseToken<T>

java.lang.Object

de.weltraumschaf.commons.token.BaseToken<T>

Type Parameters:

T - type of the recognized value

All Implemented Interfaces:

Token

Direct Known Subclasses:

BaseToken.BooleanToken, BaseToken.FloatToken, BaseToken.IntegerToken, BaseToken.StringToken

abstract class BaseToken<T>
extends Object
implements Token

Base token implementation with generic value.

Since:

1.0.0

Author:

Sven Strittmatter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	BaseToken.BooleanToken Concrete implementation of boolean token.
(package private) static class	BaseToken.FloatToken Concrete implementation of boolean token.
(package private) static class	BaseToken.IntegerToken Concrete implementation of boolean token.
(package private) static class	BaseToken.KeywordToken Concrete implementation of boolean token.
(package private) static class	BaseToken.LiteralToken Concrete implementation of boolean token.
(package private) static class	BaseToken.StringToken Concrete implementation of boolean token.

Field Summary

Fields

Modifier and Type	Field and Description
private static String	FORMAT Format string for unsupported value methods.
private Position	position Start position of token.
private String	raw Raw scanned lexeme.
private TokenType	type Token class type.
private T	value Recognized typed token value.

Constructor Summary

Constructors

Constructor and Description
BaseToken(TokenType type, Position position, String raw, T value) Dedicated constructor .

Method Summary

Methods

Modifier and Type	Method and Description
String	asString() Get the string typed value.
boolean	equals(Object obj)
Position	getPosition() Start position of the token.
String	getRaw() The raw string recognized by the scanner.
TokenType	getType() Get the token type class.
(package private) T	getValue() Get the typed value.
int	hashCode()
protected void	raiseUnsupportedValueOperationError(TokenType unsupported) Throws always an exception.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.weltraumschaf.commons.token.Token

asBoolean, asFloat, asInteger

Field Detail

FORMAT

private static final String FORMAT

Format string for unsupported value methods.

See Also:

Constant Field Values

type

private final TokenType type

Token class type.

position

private final Position position

Start position of token.

raw

private final String raw

Raw scanned lexeme.

value

private final T value

Recognized typed token value.

Constructor Detail

BaseToken

public BaseToken(TokenType type,
         Position position,
         String raw,
         T value)

Dedicated constructor .

Parameters:

type - must not be null

position - must not be null

raw - must not be null

value - must not be null

Method Detail

getType

public TokenType getType()

Description copied from interface: Token

Get the token type class.

Specified by:

getType in interface Token

Returns:

never null

getPosition

public Position getPosition()

Description copied from interface: Token

Start position of the token.

Specified by:

getPosition in interface Token

Returns:

never null

getRaw

public String getRaw()

Description copied from interface: Token

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.

Specified by:

getRaw in interface Token

Returns:

never null

getValue

T getValue()

Get the typed value.

Returns:

must not be null

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

asString

public String asString()

Description copied from interface: Token

Get the string typed value.

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

Specified by:

asString in interface Token

Returns:

never null

raiseUnsupportedValueOperationError

protected void raiseUnsupportedValueOperationError(TokenType unsupported)

Throws always an exception.

Used to signal that one of the as...() methods was called, but the value type does not match.

This method always throws UnsupportedOperationException.

Parameters:

unsupported - the unsupported type