Top Description Fields Constructors Methods
org.apache.derby.impl.sql.compile

pack-priv Class Token

extends Object
Class Inheritance

Describes the input token stream.

Field Summary

Modifier and TypeField and Description
public int
beginColumn

beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.

public int
beginLine

beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.

public int
beginOffset

beginOffset and endOffset are useful for siphoning substrings out of the Statement so that we can recompile the substrings at upgrade time.

public int
endColumn

beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.

public int
endLine

beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.

public int
endOffset

beginOffset and endOffset are useful for siphoning substrings out of the Statement so that we can recompile the substrings at upgrade time.

public String
image

The string image of the token.

public int
kind

An integer that describes the kind of this token.

public Token
next

A reference to the next regular (non-special) token from the input stream.

public Token
specialToken

This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token.

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public static Token
newToken(int ofKind)

Returns a new Token object, by default.

public String
toString()

Overrides java.lang.Object.toString.

Returns the image.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

beginColumnback to summary
public int beginColumn

beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.

beginLineback to summary
public int beginLine

beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.

beginOffsetback to summary
public int beginOffset

beginOffset and endOffset are useful for siphoning substrings out of the Statement so that we can recompile the substrings at upgrade time. For instance, VIEW definitions and the Restrictions on Published Tables need to be recompiled at upgrade time.

endColumnback to summary
public int endColumn

beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.

endLineback to summary
public int endLine

beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.

endOffsetback to summary
public int endOffset

beginOffset and endOffset are useful for siphoning substrings out of the Statement so that we can recompile the substrings at upgrade time. For instance, VIEW definitions and the Restrictions on Published Tables need to be recompiled at upgrade time.

imageback to summary
public String image

The string image of the token.

kindback to summary
public int kind

An integer that describes the kind of this token. This numbering system is determined by JavaCCParser, and a table of these numbers is stored in the file ...Constants.java.

nextback to summary
public Token next

A reference to the next regular (non-special) token from the input stream. If this is the last token from the input stream, or if the token manager has not read tokens beyond this one, this field is set to null. This is true only if this token is also a regular token. Otherwise, see below for a description of the contents of this field.

specialTokenback to summary
public Token specialToken

This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token. If there are no such special tokens, this field is set to null. When there are more than one such special token, this field refers to the last of these special tokens, which in turn refers to the next previous special token through its specialToken field, and so on until the first special token (whose specialToken field is null). The next fields of special tokens refer to other special tokens that immediately follow it (without an intervening regular token). If there is no such token, this field is null.

Constructor Detail

Tokenback to summary
pack-priv Token()

Method Detail

newTokenback to summary
public static Token newToken(int ofKind)

Returns a new Token object, by default. However, if you want, you can create and return subclass objects based on the value of ofKind. Simply add the cases to the switch for all those special cases. For example, if you have a subclass of Token called IDToken that you want to create if ofKind is ID, simlpy add something like : case MyParserConstants.ID : return new IDToken(); to the following switch statement. Then you can cast matchedToken variable to the appropriate type and use it in your lexical actions.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Returns the image.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations
@Override