TopLevelClass.Token (Output Specification)

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

インタフェース TopLevelClass.Token

すべてのスーパーインタフェース:: TopLevelClass.Node

既知の実装クラスの一覧:: TopLevelClass.Default.Token

含まれているクラス:: TopLevelClass

public static interface TopLevelClass.Token
extends TopLevelClass.Node
extends TopLevelClass.Node

トークン（構文解析対象のテキストの断片）。

トークンは構文解析対象のテキスト（ソース）の断片です。通常、トークンは字句解析器（TopLevelClass.LexicalAnalyzer）によって作られます。このクラスには、そのトークンがどのソースのどの位置の断片であるかをあらわすメソッド（getSourceName()、getIndex()、getLine()、getColumn()）が用意されていますが、これらが返す値の厳密な意味は、字句解析器などのそのトークンを構築するプログラムによって規定されます。また、これらのメソッドはサポートされていなくてもよく、その場合 UnsupportedOperationException 例外が発生します。

導入されたバージョン:: notavaCC 1.0

メソッドの概要
`int`	`getColumn()` ソース上の、このトークンが始まった位置のカラム番号（1 based）を返します。
`java.lang.String`	`getImage()` このトークンに対応する文字列を返します。
`int`	`getIndex()` ソース上の、このトークンが始まった位置のインデックス（0 based）を返します。
`int`	`getLine()` ソース上の、このトークンが始まった位置の行番号（1 based）を返します。
`java.lang.String`	`getOriginalImage()` このトークンに対応する文字列を返します。
`java.lang.String`	`getSourceName()` このトークンに対応するソースの名前を返します。
`int`	`getSymbolID()` このトークンの種類を返します。
`boolean`	`isWhite()` このトークンがホワイト・トークンの場合、`true`を返します。
`java.lang.String`	`toString()` トークンのイメージと、サポートされている場合その位置を返します。

インタフェース TopLevelClass.Node から継承されたメソッド
`getChildNodes`

メソッドの詳細

getSymbolID

int getSymbolID()

このトークンの種類を返します。

戻り値は、次のいずれかです。

戻り値	トークンの種類
`TopLevelClass.EOF_TOKEN`	`<EOF>`
`TopLevelClass.TOKEN_TERMINAL`	`TERMINAL`
その他の値	`STRING`で定義される非終端記号

戻り値:: このトークンの種類。
導入されたバージョン:: notavaCC 1.0

isWhite

boolean isWhite()

このトークンがホワイト・トークンの場合、trueを返します。

戻り値:: このトークンがホワイト・トークンの場合 true。
導入されたバージョン:: notavaCC 1.0

getImage

java.lang.String getImage()

このトークンに対応する文字列を返します。

文字列がユニコードエスケープのようなメタ表現を含む場合、戻り値は、表現されている文字列（例えば A）であり、表現（例えば \u0041）ではありません。そのようなメタ表現が含まれていない場合、このメソッドの戻り値は getOriginalImage() と同じになります。

戻り値:: このトークンに対応する文字列。
導入されたバージョン:: notavaCC 1.0
関連項目:: getOriginalImage()

getOriginalImage

java.lang.String getOriginalImage()

このトークンに対応する文字列を返します。

文字列がユニコードエスケープのようなメタ表現を含む場合、戻り値は、表現（例えば \u0041）であり、表現されている文字列（例えば A）ではありません。そのようなメタ表現が含まれていない場合、このメソッドの戻り値は getImage() と同じになります。

戻り値:: このトークンに対応する文字列。
導入されたバージョン:: notavaCC 1.0
関連項目:: getImage()

getSourceName

java.lang.String getSourceName()
                               throws java.lang.UnsupportedOperationException

このトークンに対応するソースの名前を返します。

戻り値:: ソースの名前。
例外:: java.lang.UnsupportedOperationException - サポートされない場合。
導入されたバージョン:: notavaCC 1.0

getIndex

int getIndex()
             throws java.lang.UnsupportedOperationException

ソース上の、このトークンが始まった位置のインデックス（0 based）を返します。

戻り値:: このトークンが始まった位置のインデックス。
例外:: java.lang.UnsupportedOperationException - サポートされない場合。
導入されたバージョン:: notavaCC 1.0

getLine

int getLine()
            throws java.lang.UnsupportedOperationException

ソース上の、このトークンが始まった位置の行番号（1 based）を返します。

戻り値:: このトークンが始まった位置の行番号。
例外:: java.lang.UnsupportedOperationException - サポートされない場合。
導入されたバージョン:: notavaCC 1.0

getColumn

int getColumn()
              throws java.lang.UnsupportedOperationException

ソース上の、このトークンが始まった位置のカラム番号（1 based）を返します。

戻り値:: このトークンが始まった位置のカラム番号。
例外:: java.lang.UnsupportedOperationException - サポートされない場合。
導入されたバージョン:: notavaCC 1.0

toString

java.lang.String toString()

トークンのイメージと、サポートされている場合その位置を返します。例えば、`identifier' (line 2, column 3) や `identifier' のようになります。厳密なフォーマットは規定されません。

オーバーライド:: クラス java.lang.Object 内の toString

戻り値:: トークンのイメージと位置
導入されたバージョン:: notavaCC 1.0