com.Ostermiller.Syntax.Lexer
Class PlainToken

java.lang.Object
  com.Ostermiller.Syntax.Lexer.Token
      com.Ostermiller.Syntax.Lexer.PlainToken

public class PlainToken
extends Token

A PlainToken is a token that is returned by a lexer that is lexing a plain text file. It has several attributes describing the token: The type of token, the text of the token, the line number on which it occurred, the number of characters into the input at which it started, and similarly, the number of characters into the input at which it ended.

Field Summary

static int	TEXT
static int	WHITE_SPACE

Fields inherited from class com.Ostermiller.Syntax.Lexer.Token

INITIAL_STATE, UNDEFINED_STATE

Constructor Summary

PlainToken(int ID, String contents, int lineNumber, int charBegin, int charEnd)
Create a new token.

PlainToken(int ID, String contents, int lineNumber, int charBegin, int charEnd, int state)
Create a new token.

Method Summary

String	errorString() get a String that explains the error, if this token is an error.
int	getCharBegin() get the offset into the input in characters at which this token started
int	getCharEnd() get the offset into the input in characters at which this token ended
String	getContents() get the contents of this token
String	getDescription() A description of this token.
int	getID() get the ID number of this token
int	getLineNumber() get the line number of the input on which this token started
int	getState() Get an integer representing the state the tokenizer is in after returning this token.
boolean	isComment() Checks this token to see if it is a comment.
boolean	isError() Checks this token to see if it is an Error.
boolean	isText() Checks this token to see if it is text.
boolean	isWhiteSpace() Checks this token to see if it is White Space.
String	toString() get a representation of this token as a human readable string.

Methods inherited from class java.lang.Object

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

Field Detail

TEXT

public static final int TEXT

See Also:

Constant Field Values

WHITE_SPACE

public static final int WHITE_SPACE

See Also:

Constant Field Values

Constructor Detail

PlainToken

public PlainToken(int ID,
                  String contents,
                  int lineNumber,
                  int charBegin,
                  int charEnd)

Create a new token. The constructor is typically called by the lexer

Parameters:

ID - the id number of the token

contents - A string representing the text of the token

lineNumber - the line number of the input on which this token started

charBegin - the offset into the input in characters at which this token started

charEnd - the offset into the input in characters at which this token ended

PlainToken

public PlainToken(int ID,
                  String contents,
                  int lineNumber,
                  int charBegin,
                  int charEnd,
                  int state)

Create a new token. The constructor is typically called by the lexer

Parameters:

ID - the id number of the token

contents - A string representing the text of the token

lineNumber - the line number of the input on which this token started

charBegin - the offset into the input in characters at which this token started

charEnd - the offset into the input in characters at which this token ended

state - the state the tokenizer is in after returning this token.

Method Detail

getState

public int getState()

Get an integer representing the state the tokenizer is in after returning this token. Those who are interested in incremental tokenizing for performance reasons will want to use this method to figure out where the tokenizer may be restarted. The tokenizer starts in Token.INITIAL_STATE, so any time that it reports that it has returned to this state, the tokenizer may be restarted from there.

Specified by:

getState in class Token

getID

public int getID()

get the ID number of this token

Specified by:

getID in class Token

Returns:

the id number of the token

getContents

public String getContents()

get the contents of this token

Specified by:

getContents in class Token

Returns:

A string representing the text of the token

getLineNumber

public int getLineNumber()

get the line number of the input on which this token started

Specified by:

getLineNumber in class Token

Returns:

the line number of the input on which this token started

getCharBegin

public int getCharBegin()

get the offset into the input in characters at which this token started

Specified by:

getCharBegin in class Token

Returns:

the offset into the input in characters at which this token started

getCharEnd

public int getCharEnd()

get the offset into the input in characters at which this token ended

Specified by:

getCharEnd in class Token

Returns:

the offset into the input in characters at which this token ended

isText

public boolean isText()

Checks this token to see if it is text.

Returns:

true if this token is an text, false otherwise

isWhiteSpace

public boolean isWhiteSpace()

Checks this token to see if it is White Space. Usually tabs, line breaks, form feed, spaces, etc.

Specified by:

isWhiteSpace in class Token

Returns:

true if this token is White Space, false otherwise

isError

public boolean isError()

Checks this token to see if it is an Error. Unfinished comments, numbers that are too big, unclosed strings, etc.

Specified by:

isError in class Token

Returns:

true if this token is an Error, false otherwise

isComment

public boolean isComment()

Checks this token to see if it is a comment.

Specified by:

isComment in class Token

Returns:

true if this token is a comment, false otherwise

getDescription

public String getDescription()

A description of this token. The description should be appropriate for syntax highlighting. For example "comment" is returned for a comment.

Specified by:

getDescription in class Token

Returns:

a description of this token.

errorString

public String errorString()

get a String that explains the error, if this token is an error.

Specified by:

errorString in class Token

Returns:

a String that explains the error, if this token is an error, null otherwise.

toString

public String toString()

get a representation of this token as a human readable string. The format of this string is subject to change and should only be used for debugging purposes.

Overrides:

toString in class Object

Returns:

a string representation of this token