se.l4.lect.tokens

Class MutableToken

java.lang.Object

se.l4.lect.tokens.MutableToken

All Implemented Interfaces:

Token

public class MutableToken
extends Object
implements Token

Implementation of Token that is mutable. Mutable tokens can be modified and are commonly used by LanguageParsers to reduce memory usage during parsing.

Author:

Andreas Holstenson

Constructor Summary

Constructors

Constructor and Description
MutableToken() Create a new empty token.
MutableToken(TokenType type, Location start, Location end, CharSequence text) Create a new token with a given type, location and text.

Method Summary

Modifier and Type	Method and Description
Token	copy() Get a copy of this token as an ImmutableToken.
void	copyFrom(Token other) Copy data from another token into this one.
<T> T	get(TokenProperty<T> property) Get some optional data for this token.
Location	getEnd() Get where this token ends.
Map<String,Object>	getProperties() Get properties as a Map.
Location	getStart() Get where this token starts.
String	getText() Get the text of the token.
TokenType	getType() Get the type of token.
boolean	has(TokenProperty<?> property) Get if this token has the given data.
static MutableToken	ofType(TokenType type)
<T> MutableToken	set(TokenProperty<T> property, T value) Set a property for this token.
MutableToken	setEnd(Location end)
MutableToken	setStart(Location start)
MutableToken	setText(CharSequence text)
MutableToken	setType(TokenType type)
String	toString()
void	update(TokenType type, Location start, Location end, CharSequence text) Update the data within the token.
void	update(TokenType type, Location start, Location end, CharSequence text, Map<String,Object> otherProperties) Update the data within the token including properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

MutableToken

public MutableToken()

Create a new empty token.

MutableToken

public MutableToken(TokenType type,
                    Location start,
                    Location end,
                    CharSequence text)

Create a new token with a given type, location and text.

Parameters:

type - the type of the token

start - the start of the token

end - the end of the token

text - text of the sequence, will be turned into a String internally

Method Detail

update

public void update(TokenType type,
                   Location start,
                   Location end,
                   CharSequence text)

Update the data within the token.

Parameters:

type - the type of the token

start - the start of the token

end - the end of the token

text - text of the sequence, will be turned into a String internally

update

public void update(TokenType type,
                   Location start,
                   Location end,
                   CharSequence text,
                   Map<String,Object> otherProperties)

Update the data within the token including properties.

Parameters:

type - the type of the token

start - the start of the token

end - the end of the token

text - text of the sequence, will be turned into a String internally

otherProperties - properties for the token

copyFrom

public void copyFrom(Token other)

Copy data from another token into this one.

Parameters:

other -

getType

public TokenType getType()

Description copied from interface: Token

Get the type of token.

Specified by:

getType in interface Token

Returns:

setType

public MutableToken setType(TokenType type)

getText

public String getText()

Description copied from interface: Token

Get the text of the token.

Specified by:

getText in interface Token

Returns:

setText

public MutableToken setText(CharSequence text)

getStart

public Location getStart()

Description copied from interface: Token

Get where this token starts.

Specified by:

getStart in interface Token

Returns:

setStart

public MutableToken setStart(Location start)

getEnd

public Location getEnd()

Description copied from interface: Token

Get where this token ends.

Specified by:

getEnd in interface Token

Returns:

setEnd

public MutableToken setEnd(Location end)

get

public <T> T get(TokenProperty<T> property)

Description copied from interface: Token

Get some optional data for this token.

Specified by:

get in interface Token

has

public boolean has(TokenProperty<?> property)

Description copied from interface: Token

Get if this token has the given data.

Specified by:

has in interface Token

Returns:

set

public <T> MutableToken set(TokenProperty<T> property,
                            T value)

Set a property for this token.

Parameters:

property - the property to set

value - the value of the property

Returns:

this instance

getProperties

public Map<String,Object> getProperties()

Description copied from interface: Token

Get properties as a Map.

Specified by:

getProperties in interface Token

Returns:

copy

public Token copy()

Description copied from interface: Token

Get a copy of this token as an ImmutableToken.

Specified by:

copy in interface Token

Returns:

toString

public String toString()

Overrides:

toString in class Object

ofType

public static MutableToken ofType(TokenType type)