Package eu.bandm.tools.lexic

Class SimpleToken<D,T>

java.lang.Object

eu.bandm.tools.lexic.SimpleToken<D,T>

Type Parameters:

D - the type of source document identifiers

T - the type of token types; typically an enum type

All Implemented Interfaces:

Token<D,T>

public class SimpleToken<D,T>
extends Object
implements Token<D,T>

Simple immutable token implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface eu.bandm.tools.lexic.Token

Token.Factory<D,T,R extends Token<D,T>>

Constructor Summary

Constructors

Constructor	Description
SimpleToken(T type, @Opt String text, @Opt Location<D> location)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
@Opt Location<D>	getLocation()	Returns the source location of this token.
@Opt String	getText()	Returns the text content of this token.
T	getType()	Returns the type of this token.
String	toString()	Evident
SimpleToken<D,T>	withType(T type)	Returns a token that differs from this token only by a change of token type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

SimpleToken

public SimpleToken(T type,
 @Opt
 @Opt String text,
 @Opt
 @Opt Location<D> location)

Creates a new instance.

Note that null values for token text and location are generally meaningful. Whether null token types are also valid depends on the application. If T is an enum type, it does not. However, in order to accomodate the general case, this constructor does not check the parameter type for null values either.

Parameters:

type - the token type

text - the token text, or null if not available

location - the token location, or null if not available

Method Details

getLocation

@Opt
public @Opt Location<D> getLocation()

Returns the source location of this token.

The default implementation returns null.

Specified by:

getLocation in interface Token<D,T>

Returns:

the source location of this token, or null if not available.

getType

public T getType()

Returns the type of this token.

Specified by:

getType in interface Token<D,T>

Returns:

the type of this token.

getText

@Opt
public @Opt String getText()

Returns the text content of this token.

The default implementation returns null.

Specified by:

getText in interface Token<D,T>

Returns:

the text content of this token, or null if not available.

withType

public SimpleToken<D,T> withType(T type)

Returns a token that differs from this token only by a change of token type.

The default implementation only throws UnsupportedOperationException. Implementing classes may override this method in order to enable the feature.

Specified by:

withType in interface Token<D,T>

Parameters:

type - the type of the new token

Returns:

a token that differs from this token only by having the given token type instead

toString

public String toString()

Evident

Overrides:

toString in class Object