Class Token

Describes the input token stream.

Inheritance

System.Object

Token

Namespace: Lucene.Net.QueryParsers.Surround.Parser

Assembly: Lucene.Net.QueryParser.dll

Syntax

public class Token : object

Constructors

Token()

No-argument constructor

Declaration

public Token()

Token(Int32)

Constructs a new token for the specified Image.

Declaration

public Token(int kind)

Parameters

Type	Name	Description
System.Int32	kind

Token(Int32, String)

Constructs a new token for the specified Image and Kind.

Declaration

public Token(int kind, string image)

Parameters

Type	Name	Description
System.Int32	kind
System.String	image

Properties

BeginColumn

The column number of the first character of this Token.

Declaration

public int BeginColumn { get; set; }

Property Value

Type	Description
System.Int32

BeginLine

The line number of the first character of this Token.

Declaration

public int BeginLine { get; set; }

Property Value

Type	Description
System.Int32

EndColumn

The column number of the last character of this Token.

Declaration

public int EndColumn { get; set; }

Property Value

Type	Description
System.Int32

EndLine

The line number of the last character of this Token.

Declaration

public int EndLine { get; set; }

Property Value

Type	Description
System.Int32

Image

The string image of the token.

Declaration

public string Image { get; set; }

Property Value

Type	Description
System.String

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.

Declaration

public int Kind { get; set; }

Property Value

Type	Description
System.Int32

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.

Declaration

public Token Next { get; set; }

Property Value

Type	Description
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.

Declaration

public Token SpecialToken { get; set; }

Property Value

Type	Description
Token

Value

An optional attribute value of the Token. Tokens which are not used as syntactic sugar will often contain meaningful values that will be used later on by the compiler or interpreter. This attribute value is often different from the image. Any subclass of Token that actually wants to return a non-null value can override this method as appropriate.

Declaration

public virtual object Value { get; }

Property Value

Type	Description
System.Object

Methods

NewToken(Int32)

Declaration

public static Token NewToken(int ofKind)

Parameters

Type	Name	Description
System.Int32	ofKind

Returns

Type	Description
Token

NewToken(Int32, String)

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, simply add something like :

case MyParserConstants.ID : return new IDToken(ofKind, image);

to the following switch statement. Then you can cast matchedToken variable to the appropriate type and use sit in your lexical actions.

Declaration

public static Token NewToken(int ofKind, string image)

Parameters

Type	Name	Description
System.Int32	ofKind
System.String	image

Returns

Type	Description
Token

ToString()

Returns the image.

Declaration

public override string ToString()

Returns

Type	Description
System.String