SyntaxReader (OtsuLibrary)

java.lang.Object
- otsu.symphonie.SyntaxReader

public class SyntaxReader
extends Object

構文解析機。構文定義を与え、その定義に沿って、入力文字列を解析する.

構文定義に従い、入力文字列を解析します。

構文定義法、入力解析法などの総合的な説明をパッケージ otsu.symphonieの説明で行ってありますので、まずご覧ください。

標準的使い方

次のような手順を踏みます。

SyntaxReaderを作成
SyntaxReaderに構文定義（記述ファイルなど）を設定
SyntaxReaderに入力（ファイルなど）を設定
read-APIで構文情報を読み取る

read-APIで得られる情報はSyntaxElementです。

   SyntaxReader  sr = new SyntaxReader();     //(1)SyntaxReader作成
   sr.readSyntaxFile("syntaxDef.sn","utf-8"); //(2)構文定義設定
   sr.parse("text.txt");                     //(3)入力設定
   SyntaxElement eml=new SyntaxElement();
   while( sr.read(elm,sr.END_AT_EOF) ){      //(4)読む
      _pr.println(hiU.indent(elm.nest)+elm.toXMLString(option_));
      }

もう少し細かく構文を取り扱う例を SyntaxReaderによる順次解析に置いてあります。

symphonieで用意されるその他の解析法

SyntaxReaderの他、symphonieには
(1)構文木をXML-DOMで得る機構、

  SyntaxDom syntax=new SyntaxDom();
  syntax.readSyntaxFile("syntaxDef.sn","utf-8");
  Document doc= syntax.parseFile("text.txt","utf-8",SyntaxReader.NO_INDENT);

(2)XML文字列やjson文字列で得る機構

  SyntaxConverter syntax=new SyntaxConverter();
  syntax.readSyntaxFile("syntaxDef.sn","utf-8");
  String xmlStr = syntax.parseFile("text.txt","utf-8",syntax.AS_XML);
  String jsonStr= syntax.parseFile("text.txt","utf-8",syntax.AS_JSON);

(3)解析し、構文木を表示させるコマンド

   java -jar symphonie.jar syntax-check -syntax syntaxDef.sn -source text.txt -encoding utf-8

(4)構文解析アプレット

   <!-- in HTML -->
   <applet id="app" archive="symphonie.jar"
                    code="otsu.symphonie.SymphonieApp" ...>
   <script type="text/javascript>
   var syntax="... 構文定義 ...";
   var text="... 解析したい文 ...";
   app.readSyntaxString(syntax);
   var xml=app.parseString(text,"te");
   </script>

も用意してあります。

内部クラス

SyntaxReaderは幾つかの内部クラスにより処理を進めます。

通常は意識する必要はありませんが、構文エラー検出時にこれらのクラスがExceptionを投げます。

クラス名		説明
SyntaxReaderEngine		構文の候補管理を行います
SyntaxDef		構文情報読み込み後、参照解決を行います。
SyntaxDefReaderHi		SNで書かれた構文情報を読み込みます。歴史的理由でHiと名付けられています。
TokenReaderEngine		トークン読み込みを行います。

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static int`	`AS_JSON` json文字列を得る
`static int`	`AS_XML` xml文字列を得る（デフォルト)
`static int`	`END_AT_EOF` EOFを予期していることを示す.
`static int`	`NO_INDENT` インデントを付けない
`static int`	`SKIP` 指定データまでスキップする指定.

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`SyntaxReader()` 構文情報も解析文もセットされていないSyntaxReaderを作成します。
`SyntaxReader(String syntaxFileName_)` 構文定義ファイルを読み込む.
`SyntaxReader(String syntaxFileName_, String charSet_)` 構文定義ファイルを文字コード指定で読み込む.

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`parse(BufferedReader br_)` 解析すべき入力を設定する.
`void`	`parse(String fileName_)` 解析すべき入力ファイルを設定する.
`void`	`parse(String fileName_, String charSet_)` 解析すべき入力ファイルを設定する.
`void`	`parseFile(String fileName_)` 解析すべき入力ファイルを設定する.
`void`	`parseFile(String fileName_, String charSet_)` 解析すべき入力ファイルを設定する.
`void`	`parseString(ArrayList<String> text_)` 解析すべき文字列を設定する.
`void`	`parseString(String text_)` 解析すべき文字列を設定する.
`void`	`parseString(String[] text_)` 解析すべき文字列を設定する.
`void`	`printCurrent(PrintStream ps_)` 現状の文法候補情報を印刷する
`void`	`printCurrent(PrintWriter ps_)` 現状の文法候補情報を印刷する
`void`	`printSyntax(PrintStream ps_)` 構文情報を印刷する
`void`	`printSyntax(PrintWriter ps_)` 構文情報を印刷する
`void`	`printSyntaxDict(PrintStream ps_)` 構文情報(定義別）を印刷する
`void`	`printSyntaxDict(PrintWriter ps_)` 構文情報(定義別）を印刷する
`void`	`printTokenPriority(PrintStream ps_)` トークンの優先情報を印刷する
`void`	`printTokenPriority(PrintWriter ps_)` トークンの優先情報を印刷する
`void`	`printTokens(PrintStream ps_)` トークンの優先情報を印刷する
`void`	`printTokens(PrintWriter ps_)` トークンの優先情報を印刷する
`void`	`push(SyntaxElement elm_)` 構文要素を戻す。
`SyntaxElement`	`read()` 構文要素を読む.EOFはExceptionとなる
`SyntaxElement`	`read(long option_)` 構文要素を読む。
`SyntaxElement`	`read(SyntaxElement elm_)` 構文要素を読む.EOFはExceptionとなる
`boolean`	`read(SyntaxElement elm_, long option_)` 構文要素を読む。
`SyntaxElement`	`readBegin()` 開始要素を読む。
`SyntaxElement`	`readBegin(String name_)` 開始要素を指定して読む。
`SyntaxElement`	`readBegin(SyntaxElement elm_)` 開始要素を読む。
`SyntaxElement`	`readBegin(SyntaxElement elm_, String name_)` 開始要素を指定して読む。
`SyntaxElement`	`readEnd()` 終了要素を読む。
`SyntaxElement`	`readEnd(String name_)` 指定終了要素を読む。
`SyntaxElement`	`readEnd(SyntaxElement elm_)` 終了要素を読む。
`SyntaxElement`	`readEnd(SyntaxElement elm_, String name_)` 指定終了要素を読む。
`SyntaxElement`	`readNotEnd(SyntaxElement elm_)` 終了以外を読む。
`void`	`readResSyntaxFile(Class class_, String fileName_)` ファイル名を指定してリソース上の標準構文定義ファイルを読み込む.
`void`	`readResSyntaxFile(String fileName_)` ファイル名を指定してリソース上の標準構文定義ファイルを読み込む.
`void`	`readResSyntaxFile(String fileName_, String charSet_)` ファイル名を指定してリソース上の標準構文定義ファイルを読み込む.
`void`	`readResSyntaxObjectFile(Class class_, String objFile_)` リソース上の構文定義オブジェクトを読み込む
`void`	`readResSyntaxObjectFile(String objFile_)` リソース上の構文定義オブジェクトを読み込む
`void`	`readSyntax(BufferedReader rd_)` オープンされているテキスト入力機を用いて構文定義を読み込む.
`void`	`readSyntax(String fileName_)` ファイル名を指定して標準構文定義ファイルを読み込む.
`void`	`readSyntax(String fileName_, String charSet_)` ファイル名、文字セット名を指定して標準構文定義ファイルを読み込む.
`void`	`readSyntaxFile(Class class_, String fileName_, String charSet_)` ファイル名を指定してリソース上の標準構文定義ファイルを読み込む.
`void`	`readSyntaxFile(String fileName_)` ファイル名を指定して標準構文定義ファイルを読み込む.
`void`	`readSyntaxFile(String fileName_, String charSet_)` ファイル名を指定して標準構文定義ファイルを読み込む.
`void`	`readSyntaxObject(ObjectInputStream ois_)` 構文定義オブジェクトを読み込む
`void`	`readSyntaxObjectFile(String objFile_)` 構文定義オブジェクトを読み込む
`void`	`readSyntaxString(String syntax_)` Stringにセットされている構文定義を読み込む.
`void`	`readSyntaxString(String[] syntax_)` Stringにセットされている構文定義を読み込む。
`SyntaxElement`	`readToken(String name_)` トークン名を指定して読む。
`SyntaxElement`	`readToken(SyntaxElement elm_)` トークンを読む。
`SyntaxElement`	`readToken(SyntaxElement elm_, String name_)` トークン名を指定して読む。
`int`	`readType(SyntaxElement elm_)` 構文要素を読む.EOFはExceptionとなる
`int`	`readType(SyntaxElement elm_, long option_)` 構文要素を読む。
`void`	`restart()` 構文定義を残し、解析状態をリセットする。
`void`	`setSourceName(String textSourceName_)` 解析されるソース名を設定する.
`void`	`setSyntaxSourceName(String syntaxSourceName_)` 構文定義ソース名を設定する.
`void`	`setTokenHook(TokenHook_if hook_)` 解析途中のトークン読み取り部で、情報をフックする.
`void`	`skip()` 現構文階層のENDまでスキップする.
`void`	`skip(int n_)` 指定階層のENDまでスキップ
`void`	`skip(SyntaxElement elm_)` 現構文階層のENDまでスキップする.
`void`	`skip(SyntaxElement elm_, int nest_)` 指定階層のENDまでスキップ
`void`	`tokenAsBeginEnd(boolean yes_)` トークンをBEGIN,ENDで通知する.
`boolean`	`tryReadBegin(String name_)` 開始要素を指定して読む。
`boolean`	`tryReadBegin(String name_, long option_)` 開始要素を指定して読む。
`boolean`	`tryReadBegin(SyntaxElement elm_)` 開始要素を読む。
`boolean`	`tryReadBegin(SyntaxElement elm_, String name_)` 開始要素を指定して読む。
`boolean`	`tryReadBegin(SyntaxElement elm_, String name_, long option_)` 開始要素を指定して読む。
`boolean`	`tryReadBeginEnd(String name_)` 開始要素を指定して読む。
`boolean`	`tryReadBeginEnd(SyntaxElement elm_, String name_)` 開始要素を指定して読む。
`boolean`	`tryReadEnd(SyntaxElement elm_)` 終了要素を読む.
`boolean`	`tryReadEnd(SyntaxElement elm_, String name_)` 指定終了要素を読む終了要素でない場合偽が返る。
`boolean`	`tryReadNotEnd(SyntaxElement elm_)` 終了以外を読む。
`boolean`	`tryReadToken(SyntaxElement elm_)` トークンを読む。
`boolean`	`tryReadToken(SyntaxElement elm_, String name_)` トークン名を指定して読む。
`boolean`	`tryReadToken(SyntaxElement elm_, String name_, long option_)` トークン名を指定して読む。
`void`	`writeSyntaxObject(ObjectOutputStream oos_)` 構文定義オブジェクトを書き出す
`void`	`writeSyntaxObjectFile(String fileName_)` 構文定義オブジェクトを書き出す

クラスから継承されたメソッド java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - END_AT_EOF
```
public static final int END_AT_EOF
```
    EOFを予期していることを示す.
    read系のAPIでこの指定をすると、データ先頭でEOFとなった場合 EOFデータまたは偽を返します。
    この指定が無い場合はUnexpectedEOFExceptionまたはEOFException となります。
    
    関連項目:
    
    定数フィールド値
  - SKIP
```
public static final int SKIP
```
    指定データまでスキップする指定. read系のAPIでこの指定をすると、当該データまでスキップします
    
    関連項目:
    
    定数フィールド値
  - NO_INDENT
```
public static final int NO_INDENT
```
    インデントを付けない
    
    関連項目:
    
    定数フィールド値
  - AS_JSON
```
public static final int AS_JSON
```
    json文字列を得る
    
    関連項目:
    
    定数フィールド値
  - AS_XML
```
public static final int AS_XML
```
    xml文字列を得る（デフォルト)
    
    関連項目:
    
    定数フィールド値
- コンストラクタの詳細
  - SyntaxReader
```
public SyntaxReader()
```
    構文情報も解析文もセットされていないSyntaxReaderを作成します。
  - SyntaxReader
```
public SyntaxReader(String syntaxFileName_)
             throws Exception
```
    構文定義ファイルを読み込む.(UTF-8)
    
    パラメータ:
    
    syntaxFileName_ - 構文定義ファイル名
    
    例外:
    
    Exception - 失敗
  - SyntaxReader
```
public SyntaxReader(String syntaxFileName_,
                    String charSet_)
             throws Exception
```
    構文定義ファイルを文字コード指定で読み込む.
    指定の構文テキストファイルを読み、解析対象ファイルをセットします。
    
    パラメータ:
    
    syntaxFileName_ - 構文定義ファイル名
    
    charSet_ - SN形式の場合の文字コード
    
    例外:
    
    Exception - 失敗
- メソッドの詳細
  - readSyntax
```
public void readSyntax(String fileName_)
                throws Exception
```
    ファイル名を指定して標準構文定義ファイルを読み込む.
    
    パラメータ:
    
    fileName_ - 構文定義ファイル名
    
    例外:
    
    Exception - 読み込み/解析失敗
  - readSyntaxFile
```
public void readSyntaxFile(String fileName_)
                    throws Exception
```
    ファイル名を指定して標準構文定義ファイルを読み込む.
    readSyntaxFile(String)と同じです
    
    パラメータ:
    
    fileName_ - 構文定義ファイル名
    
    例外:
    
    Exception - 読み込み/解析失敗
  - readSyntax
```
public void readSyntax(String fileName_,
                       String charSet_)
                throws Exception
```
    ファイル名、文字セット名を指定して標準構文定義ファイルを読み込む.
    
    パラメータ:
    
    fileName_ - 構文定義ファイル名
    
    charSet_ - 文字セット名
    
    例外:
    
    Exception - 読み込み/解析失敗
  - readSyntaxFile
```
public void readSyntaxFile(String fileName_,
                           String charSet_)
                    throws Exception
```
    ファイル名を指定して標準構文定義ファイルを読み込む.
    readSyntaxFile(String,String)と同じです
    
    パラメータ:
    
    fileName_ - 構文定義ファイル名
    
    charSet_ - 文字セット名
    
    例外:
    
    Exception - 読み込み/解析失敗
  - readResSyntaxFile
```
public void readResSyntaxFile(String fileName_)
                       throws Exception
```
    ファイル名を指定してリソース上の標準構文定義ファイルを読み込む.
    
    パラメータ:
    
    fileName_ - 構文定義ファイル名
    
    例外:
    
    Exception - 読み込み/解析失敗
  - readResSyntaxFile
```
public void readResSyntaxFile(String fileName_,
                              String charSet_)
                       throws Exception
```
    ファイル名を指定してリソース上の標準構文定義ファイルを読み込む.
    
    パラメータ:
    
    fileName_ - 構文定義ファイル名
    
    charSet_ - 文字セット名
    
    例外:
    
    Exception - 読み込み/解析失敗
  - readResSyntaxFile
```
public void readResSyntaxFile(Class class_,
                              String fileName_)
                       throws Exception
```
    ファイル名を指定してリソース上の標準構文定義ファイルを読み込む.
    
    パラメータ:
    
    class_ - リソースの代表クラス
    
    fileName_ - 構文定義ファイル名
    
    例外:
    
    Exception - 読み込み/解析失敗
  - readSyntaxFile
```
public void readSyntaxFile(Class class_,
                           String fileName_,
                           String charSet_)
                    throws Exception
```
    ファイル名を指定してリソース上の標準構文定義ファイルを読み込む.
    
    パラメータ:
    
    class_ - リソースの代表クラス
    
    fileName_ - 構文定義ファイル名
    
    charSet_ - 文字セット名
    
    例外:
    
    Exception - 読み込み/解析失敗
  - readSyntaxObjectFile
```
public void readSyntaxObjectFile(String objFile_)
                          throws Exception
```
    構文定義オブジェクトを読み込む
    
    パラメータ:
    
    objFile_ - オブジェクトファイル
    
    例外:
    
    Exception - 読み込み/解析失敗
  - readResSyntaxObjectFile
```
public void readResSyntaxObjectFile(String objFile_)
                             throws Exception
```
    リソース上の構文定義オブジェクトを読み込む
    
    パラメータ:
    
    objFile_ - オブジェクトファイル
    
    例外:
    
    Exception - 読み込み/解析失敗
  - readResSyntaxObjectFile
```
public void readResSyntaxObjectFile(Class class_,
                                    String objFile_)
                             throws Exception
```
    リソース上の構文定義オブジェクトを読み込む
    
    パラメータ:
    
    class_ - リソースの代表クラス
    
    objFile_ - オブジェクトファイル
    
    例外:
    
    Exception - 読み込み/解析失敗
  - readSyntax
```
public void readSyntax(BufferedReader rd_)
                throws Exception
```
    オープンされているテキスト入力機を用いて構文定義を読み込む.
    
    パラメータ:
    
    rd_ - テキスト入力機
    
    例外:
    
    Exception - 読み込み/解析失敗
  - readSyntaxString
```
public void readSyntaxString(String syntax_)
                      throws Exception
```
    Stringにセットされている構文定義を読み込む.
    SN形式(SymphonicNotation) の構文定義を読み込みます。
    
    パラメータ:
    
    syntax_ - 構文定義
    
    例外:
    
    Exception - 解析失敗
  - readSyntaxString
```
public void readSyntaxString(String[] syntax_)
                      throws Exception
```
    Stringにセットされている構文定義を読み込む。
    SN形式(SymphonicNotation) の構文定義を読み込みます。
    配列の各要素は行と見なされます。文字列自体には改行コードは不要です。
    
    パラメータ:
    
    syntax_ - 構文定義
    
    例外:
    
    Exception - 解析失敗
  - setSyntaxSourceName
```
public void setSyntaxSourceName(String syntaxSourceName_)
                         throws Exception
```
    構文定義ソース名を設定する.
    
    パラメータ:
    
    syntaxSourceName_ - ソース名
    
    例外:
    
    Exception - 設定失敗
  - restart
```
public void restart()
```
    構文定義を残し、解析状態をリセットする。
  - setSourceName
```
public void setSourceName(String textSourceName_)
                   throws Exception
```
    解析されるソース名を設定する.
    ソース名を与えないparseで仮のソース名を設定します。エラー時にはこの名前が出ます。必須ではありません。
    
    パラメータ:
    
    textSourceName_ - ソース名
    
    例外:
    
    Exception - 設定失敗
  - parse
```
public void parse(BufferedReader br_)
           throws Exception
```
    解析すべき入力を設定する.
    この関数は直ちにリターンします。
    この後readBegin(String)などを呼び出してください。
    一旦行分解を行って解析します。改行コードは"\n"に置き換えて解析されます。
    
    パラメータ:
    
    br_ - テキスト入力機
    
    例外:
    
    Exception - 解析失敗
  - parse
```
public void parse(String fileName_)
           throws Exception
```
    解析すべき入力ファイルを設定する.
    ファイルはこの関数の中でオープンされます。
    この関数は直ちにリターンします。
    この後readBegin(String)などを呼び出してください。
    一旦行分解を行って解析します。改行コードは"\n"に置き換えて解析されます。
    
    パラメータ:
    
    fileName_ - ファイル名
    
    例外:
    
    Exception - 読み込み/解析失敗
  - parse
```
public void parse(String fileName_,
                  String charSet_)
           throws Exception
```
    解析すべき入力ファイルを設定する.
    ファイルはこの関数の中でオープンされます。この関数は直ちにリターンします。
    この後readBegin(String)などを呼び出してください。
    一旦行分解を行って解析します。改行コードは"\n"に置き換えて解析されます。
    
    パラメータ:
    
    fileName_ - ファイル名
    
    charSet_ - 文字セット
    
    例外:
    
    Exception - 読み込み/解析失敗
  - parseFile
```
public void parseFile(String fileName_)
               throws Exception
```
    解析すべき入力ファイルを設定する.
    ファイルはこの関数の中でオープンされます。
    この関数は直ちにリターンします。
    この後readBegin(String)などを呼び出してください。
    一旦行分解を行って解析します。改行コードは"\n"に置き換えて解析されます。
    
    パラメータ:
    
    fileName_ - ファイル名
    
    例外:
    
    Exception - 読み込み/解析失敗
  - parseFile
```
public void parseFile(String fileName_,
                      String charSet_)
               throws Exception
```
    解析すべき入力ファイルを設定する.
    ファイルはこの関数の中でオープンされます。この関数は直ちにリターンします。
    この後readBegin(String)などを呼び出してください。
    一旦行分解を行って解析します。改行コードは"\n"に置き換えて解析されます。
    
    パラメータ:
    
    fileName_ - ファイル名
    
    charSet_ - 文字セット
    
    例外:
    
    Exception - 読み込み/解析失敗
  - parseString
```
public void parseString(String text_)
                 throws Exception
```
    解析すべき文字列を設定する.
    この関数は直ちにリターンします。
    この後readBegin(String)などを呼び出してください。
    一旦行分解を行って解析します。改行コードは"\n"に置き換えて解析されます。
    
    パラメータ:
    
    text_ - 解析する文字列
    
    例外:
    
    Exception - 解析失敗
  - parseString
```
public void parseString(String[] text_)
                 throws Exception
```
    解析すべき文字列を設定する.
    この関数は直ちにリターンします。
    この後readBegin(String)などを呼び出してください。
    配列の各要素は行と見なされます。文字列自体に改行コードは不要です。
    各行データには改行コード"\n"が最後に付加されます。行内に改行コードがある場合、複合行として取り扱われます。行、改行コードの取り扱い参照。
    
    パラメータ:
    
    text_ - 解析する文字列
    
    例外:
    
    Exception - 解析失敗
  - parseString
```
public void parseString(ArrayList<String> text_)
                 throws Exception
```
    解析すべき文字列を設定する.
    この関数は直ちにリターンします。
    この後readBegin(String)などを呼び出してください。
    配列の各要素は行と見なされます。文字列自体に改行コードは不要です。
    各行データには改行コード"\n"が最後に付加されます。行内に改行コードがある場合、複合行として取り扱われます。行、改行コードの取り扱い参照。
    
    パラメータ:
    
    text_ - 解析する文字列
    
    例外:
    
    Exception - 解析失敗
  - setTokenHook
```
public void setTokenHook(TokenHook_if hook_)
```
    解析途中のトークン読み取り部で、情報をフックする.
    
    パラメータ:
    
    hook_ - TokenHook_ifの実装オブジェクト
  - read
```
public SyntaxElement read(SyntaxElement elm_)
                   throws Exception
```
    構文要素を読む.EOFはExceptionとなる
    
    パラメータ:
    
    elm_ - このElementに情報を得る
    
    戻り値:
    
    elm_そのもの
    
    例外:
    
    Exception - EOF/解析失敗
  - read
```
public boolean read(SyntaxElement elm_,
                    long option_)
             throws Exception
```
    構文要素を読む。option_にEND_AT_EOFを指定するとEOFでfalseとすることができる。
    END_AT_EOFを指定しない場合EOFはEOFExceptionとなる
    
    パラメータ:
    
    elm_ - このElementに情報を得る
    
    option_ - オプション
    
    戻り値:
    
    真：情報あり、偽：EOF
    
    例外:
    
    Exception - EOF/解析失敗
  - read
```
public SyntaxElement read(long option_)
                   throws Exception
```
    構文要素を読む。option_にEND_AT_EOFを指定するとEOF時にnullが返る。
    END_AT_EOFを指定しない場合EOF時はEOFExceptionとなる。
    
    パラメータ:
    
    option_ - オプション
    
    戻り値:
    
    elm_そのもの
    
    例外:
    
    Exception - EOF/解析失敗
  - read
```
public SyntaxElement read()
                   throws Exception
```
    構文要素を読む.EOFはExceptionとなる
    
    戻り値:
    
    読み取ったSyntaxElement
    
    例外:
    
    Exception - EOF/解析失敗
  - readType
```
public int readType(SyntaxElement elm_)
             throws Exception
```
    構文要素を読む.EOFはExceptionとなる
    
    パラメータ:
    
    elm_ - このElementに情報を得る
    
    戻り値:
    
    Elementのタイプ
    
    例外:
    
    Exception - EOF/解析失敗
  - readType
```
public int readType(SyntaxElement elm_,
                    long option_)
             throws Exception
```
    構文要素を読む。option_にEND_AT_EOFを指定するとEOFも戻り値になる
    
    パラメータ:
    
    elm_ - このElementに情報を得る
    
    option_ - オプション
    
    戻り値:
    
    Elementのタイプ
    
    例外:
    
    Exception - EOF/解析失敗
  - readBegin
```
public SyntaxElement readBegin(SyntaxElement elm_)
                        throws Exception
```
    開始要素を読む。指定と異なる場合例外を発生させる.
    
    パラメータ:
    
    elm_ - 情報を受け取るSyntaxElement
    
    戻り値:
    
    elm_そのもの
    
    例外:
    
    Exception - 解析失敗
  - readBegin
```
public SyntaxElement readBegin()
                        throws Exception
```
    開始要素を読む。指定と異なる場合例外を発生させる.
    
    戻り値:
    
    要素
    
    例外:
    
    Exception - 解析失敗
  - tryReadBegin
```
public boolean tryReadBegin(SyntaxElement elm_)
                     throws Exception
```
    開始要素を読む。指定と異なる場合偽となる。偽の場合再読み込み可能.
    
    パラメータ:
    
    elm_ - 情報を受け取るSyntaxElement
    
    戻り値:
    
    真：指定と合致、偽：指定と合致しない。
    
    例外:
    
    Exception - 解析失敗
  - readBegin
```
public SyntaxElement readBegin(SyntaxElement elm_,
                               String name_)
                        throws Exception
```
    開始要素を指定して読む。指定と異なる場合例外を発生させる.
    
    パラメータ:
    
    elm_ - 情報を受け取るSyntaxElement
    
    name_ - 構文要素名
    
    戻り値:
    
    elm_そのもの
    
    例外:
    
    Exception - 解析失敗
  - readBegin
```
public SyntaxElement readBegin(String name_)
                        throws Exception
```
    開始要素を指定して読む。指定と異なる場合例外を発生させる.
    
    パラメータ:
    
    name_ - 構文要素名
    
    戻り値:
    
    読み取ったSyntaxElement
    
    例外:
    
    Exception - 解析失敗
  - tryReadBegin
```
public boolean tryReadBegin(SyntaxElement elm_,
                            String name_)
                     throws Exception
```
    開始要素を指定して読む。指定と異なる場合falseが返る. falseの場合、再読み込み可
    
    パラメータ:
    
    elm_ - 情報を受け取るSyntaxElement
    
    name_ - 構文要素名
    
    戻り値:
    
    真：指定と合致、偽：指定と合致しない。
    
    例外:
    
    Exception - 解析失敗
  - tryReadBeginEnd
```
public boolean tryReadBeginEnd(SyntaxElement elm_,
                               String name_)
                        throws Exception
```
    開始要素を指定して読む。指定名のENDは１個読み飛ばします指定と異なる場合falseが返る. falseの場合、再読み込み可
    
    パラメータ:
    
    elm_ - 情報を受け取るSyntaxElement
    
    name_ - 構文要素名
    
    戻り値:
    
    真：指定と合致、偽：指定と合致しない。
    
    例外:
    
    Exception - 解析失敗
  - tryReadBegin
```
public boolean tryReadBegin(SyntaxElement elm_,
                            String name_,
                            long option_)
                     throws Exception
```
    開始要素を指定して読む。指定と異なる場合falseが返る. falseの場合、再読み込み可.
    第３引数にSKIPを指定すると読み込みに先立ち ENDをスキップさせることが出来ます。SKIP指定時は必ずスキップします。TryReadBeginEndと異なることに注意してください。
    
    パラメータ:
    
    elm_ - 情報を受け取るSyntaxElement
    
    name_ - 構文要素名
    
    option_ - オプション
    
    戻り値:
    
    真：指定と合致、偽：指定と合致しない。
    
    例外:
    
    Exception - 解析失敗
  - tryReadBegin
```
public boolean tryReadBegin(String name_)
                     throws Exception
```
    開始要素を指定して読む。指定と異なる場合falseが返る. falseの場合、再読み込み可.
    
    パラメータ:
    
    name_ - 構文要素名
    
    戻り値:
    
    真：指定と合致、偽：指定と合致しない。
    
    例外:
    
    Exception - 解析失敗
  - tryReadBeginEnd
```
public boolean tryReadBeginEnd(String name_)
                        throws Exception
```
    開始要素を指定して読む。指定名のENDは１個読み飛ばします。指定と異なる場合falseが返る. falseの場合、再読み込み可.
    
    パラメータ:
    
    name_ - 構文要素名
    
    戻り値:
    
    真：指定と合致、偽：指定と合致しない。
    
    例外:
    
    Exception - 解析失敗
  - tryReadBegin
```
public boolean tryReadBegin(String name_,
                            long option_)
                     throws Exception
```
    開始要素を指定して読む。指定と異なる場合falseが返る. falseの場合、再読み込み可.
    第３引数にSKIPを指定すると読み込み先だち ENDをスキップさせることが出来ます。SKIP指定時は必ずスキップします。TryReadBeginEndと異なることに注意してください。
    
    パラメータ:
    
    name_ - 構文要素名
    
    option_ - オプション
    
    戻り値:
    
    真：指定と合致、偽：指定と合致しない。
    
    例外:
    
    Exception - 解析失敗
  - readToken
```
public SyntaxElement readToken(SyntaxElement elm_,
                               String name_)
                        throws Exception
```
    トークン名を指定して読む。指定と異なる場合例外を発生させる.
    
    パラメータ:
    
    elm_ - 情報を受け取るSyntaxElement
    
    name_ - トークン名
    
    戻り値:
    
    elm_そのもの
    
    例外:
    
    Exception - 解析失敗
  - readToken
```
public SyntaxElement readToken(String name_)
                        throws Exception
```
    トークン名を指定して読む。指定と異なる場合例外を発生させる。
    戻り値はSyntaxElementですので　sr.readToken("NAME").text のように内容を得ることもできます。
    
    パラメータ:
    
    name_ - トークン名
    
    戻り値:
    
    読み取ったトークン情報
    
    例外:
    
    Exception - 解析失敗
  - readToken
```
public SyntaxElement readToken(SyntaxElement elm_)
                        throws Exception
```
    トークンを読む。トークンでない場合例外を発生させる.
    
    パラメータ:
    
    elm_ - 情報を受け取るSyntaxElement
    
    戻り値:
    
    elm_そのもの
    
    例外:
    
    Exception - 解析失敗
  - tryReadToken
```
public boolean tryReadToken(SyntaxElement elm_)
                     throws Exception
```
    トークンを読む。トークンでない場合falseとなる。falseの場合再読み込み可
    
    パラメータ:
    
    elm_ - 情報を受け取るSyntaxElement
    
    戻り値:
    
    真：トークンを読み込んだ。偽：トークンではなかった
    
    例外:
    
    Exception - 解析失敗
  - tryReadToken
```
public boolean tryReadToken(SyntaxElement elm_,
                            String name_)
                     throws Exception
```
    トークン名を指定して読む。指定と異なる場合falseが返る. falseの場合再読み込み可
    
    パラメータ:
    
    elm_ - 情報を受け取るSyntaxElement
    
    name_ - トークン名
    
    戻り値:
    
    真：トークンを読み込んだ。偽：トークンではなかった
    
    例外:
    
    Exception - 解析失敗
  - tryReadToken
```
public boolean tryReadToken(SyntaxElement elm_,
                            String name_,
                            long option_)
                     throws Exception
```
    トークン名を指定して読む。指定と異なる場合falseが返る. falseの場合再読み込み可
    オプションにSKIPを指定するとトークンに先立つENDは読み飛ばされる。
    
    パラメータ:
    
    elm_ - 情報を受け取るSyntaxElement
    
    name_ - トークン名
    
    option_ - オプション
    
    戻り値:
    
    真：トークンを読み込んだ。偽：トークンではなかった
    
    例外:
    
    Exception - 解析失敗
  - readNotEnd
```
public SyntaxElement readNotEnd(SyntaxElement elm_)
                         throws Exception
```
    終了以外を読む。指定と異なる場合例外を発生させる.
    
    パラメータ:
    
    elm_ - 情報を受け取るSyntaxElement
    
    戻り値:
    
    elm_そのもの
    
    例外:
    
    Exception - 解析失敗
  - tryReadNotEnd
```
public boolean tryReadNotEnd(SyntaxElement elm_)
                      throws Exception
```
    終了以外を読む。指定と異なる場合偽となる。偽の場合再読み込み可能.
    
    パラメータ:
    
    elm_ - 情報を受け取るSyntaxElement
    
    戻り値:
    
    終了以外(BEGIN/TOKEN)であった
    
    例外:
    
    Exception - 解析失敗
  - readEnd
```
public SyntaxElement readEnd()
                      throws Exception
```
    終了要素を読む。終了でない場合例外が発生する
    
    戻り値:
    
    読み込んだ終了SyntaxElement
    
    例外:
    
    Exception - 解析失敗
  - readEnd
```
public SyntaxElement readEnd(SyntaxElement elm_)
                      throws Exception
```
    終了要素を読む。終了でない場合例外が発生する
    
    パラメータ:
    
    elm_ - 情報を受け取るSyntaxElement
    
    戻り値:
    
    elm_そのもの
    
    例外:
    
    Exception - 解析失敗
  - readEnd
```
public SyntaxElement readEnd(SyntaxElement elm_,
                             String name_)
                      throws Exception
```
    指定終了要素を読む。終了でない場合例外が発生する
    
    パラメータ:
    
    elm_ - 情報を受け取るSyntaxElement
    
    name_ - 構文要素名
    
    戻り値:
    
    elm_そのもの
    
    例外:
    
    Exception - 解析失敗
  - tryReadEnd
```
public boolean tryReadEnd(SyntaxElement elm_)
                   throws Exception
```
    終了要素を読む. 終了要素でない場合偽が返る。偽の場合再読み込み可
    
    パラメータ:
    
    elm_ - 情報を受け取るSyntaxElement
    
    戻り値:
    
    真：終了要素であった、偽：終了要素ではなかった。
    
    例外:
    
    Exception - 解析失敗
  - tryReadEnd
```
public boolean tryReadEnd(SyntaxElement elm_,
                          String name_)
                   throws Exception
```
    指定終了要素を読む終了要素でない場合偽が返る。偽の場合再読み込み可
    
    パラメータ:
    
    elm_ - 情報を受け取るSyntaxElement
    
    name_ - 構文要素名
    
    戻り値:
    
    真：終了要素であった、偽：終了要素ではなかった
    
    例外:
    
    Exception - 解析失敗
  - readEnd
```
public SyntaxElement readEnd(String name_)
                      throws Exception
```
    指定終了要素を読む。終了でない場合例外が発生する
    
    パラメータ:
    
    name_ - 要素名
    
    戻り値:
    
    要素
    
    例外:
    
    Exception - 解析失敗
  - skip
```
public void skip()
          throws Exception
```
    現構文階層のENDまでスキップする.
    
    例外:
    
    Exception - 解析失敗
  - skip
```
public void skip(SyntaxElement elm_)
          throws Exception
```
    現構文階層のENDまでスキップする.
    
    パラメータ:
    
    elm_ - END情報を取り込むSyntaxElement
    
    例外:
    
    Exception - 解析失敗
  - skip
```
public void skip(int n_)
          throws Exception
```
    指定階層のENDまでスキップ
    
    パラメータ:
    
    n_ - 階層(1なら現階層、２以上ならより浅い階層まで読み飛ばす)
    
    例外:
    
    Exception - 解析失敗
  - skip
```
public void skip(SyntaxElement elm_,
                 int nest_)
          throws Exception
```
    指定階層のENDまでスキップ
    
    パラメータ:
    
    elm_ - END情報を取り込むSyntaxElement
    
    nest_ - 階層(1なら現階層、２以上ならより浅い階層まで読み飛ばす)
    
    例外:
    
    Exception - 解析失敗
  - push
```
public void push(SyntaxElement elm_)
          throws Exception
```
    構文要素を戻す。次のreadで読まれる.
    
    パラメータ:
    
    elm_ - 書き戻すSyntaxElement
    
    例外:
    
    Exception - 解析失敗
  - tokenAsBeginEnd
```
public void tokenAsBeginEnd(boolean yes_)
```
    トークンをBEGIN,ENDで通知する.
    通常はトークンはtype=SyntaxElement.TOKENで１回で通知されますがこの指定をすると、BEGIN/ENDで通知されます。
    
    パラメータ:
    
    yes_ - trueなら以後トークンをBEGIN/ENDで通知する形となります。
  - printSyntax
```
public void printSyntax(PrintWriter ps_)
```
    構文情報を印刷する
    
    パラメータ:
    
    ps_ - 印刷ストリーム
  - printSyntax
```
public void printSyntax(PrintStream ps_)
```
    構文情報を印刷する
    
    パラメータ:
    
    ps_ - 印刷ストリーム
  - printCurrent
```
public void printCurrent(PrintStream ps_)
```
    現状の文法候補情報を印刷する
    
    パラメータ:
    
    ps_ - 印刷ストリーム
  - printCurrent
```
public void printCurrent(PrintWriter ps_)
```
    現状の文法候補情報を印刷する
    
    パラメータ:
    
    ps_ - 印刷ストリーム
  - printSyntaxDict
```
public void printSyntaxDict(PrintStream ps_)
```
    構文情報(定義別）を印刷する
    
    パラメータ:
    
    ps_ - 印刷ストリーム
  - printSyntaxDict
```
public void printSyntaxDict(PrintWriter ps_)
```
    構文情報(定義別）を印刷する
    
    パラメータ:
    
    ps_ - 印刷ストリーム
  - printTokenPriority
```
public void printTokenPriority(PrintStream ps_)
```
    トークンの優先情報を印刷する
    
    パラメータ:
    
    ps_ - 印刷ストリーム
  - printTokenPriority
```
public void printTokenPriority(PrintWriter ps_)
```
    トークンの優先情報を印刷する
    
    パラメータ:
    
    ps_ - 印刷ストリーム
  - printTokens
```
public void printTokens(PrintStream ps_)
```
    トークンの優先情報を印刷する
    
    パラメータ:
    
    ps_ - 印刷ストリーム
  - printTokens
```
public void printTokens(PrintWriter ps_)
```
    トークンの優先情報を印刷する
    
    パラメータ:
    
    ps_ - 印刷ストリーム
  - writeSyntaxObject
```
public void writeSyntaxObject(ObjectOutputStream oos_)
                       throws Exception
```
    構文定義オブジェクトを書き出す
    
    パラメータ:
    
    oos_ - 出力用ストリーム
    
    例外:
    
    Exception - 失敗
  - writeSyntaxObjectFile
```
public void writeSyntaxObjectFile(String fileName_)
                           throws Exception
```
    構文定義オブジェクトを書き出す
    
    パラメータ:
    
    fileName_ - 出力用ファイル名
    
    例外:
    
    Exception - 失敗
  - readSyntaxObject
```
public void readSyntaxObject(ObjectInputStream ois_)
                      throws Exception
```
    構文定義オブジェクトを読み込む
    
    パラメータ:
    
    ois_ - 入力用ストリーム
    
    例外:
    
    Exception - 失敗

クラス SyntaxReader

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

END_AT_EOF

SKIP

NO_INDENT

AS_JSON

AS_XML

コンストラクタの詳細

SyntaxReader

SyntaxReader

SyntaxReader

メソッドの詳細

readSyntax

readSyntaxFile

readSyntax

readSyntaxFile

readResSyntaxFile

readResSyntaxFile

readResSyntaxFile

readSyntaxFile

readSyntaxObjectFile

readResSyntaxObjectFile

readResSyntaxObjectFile

readSyntax

readSyntaxString

readSyntaxString

setSyntaxSourceName

restart

setSourceName

parse

parse

parse

parseFile

parseFile

parseString

parseString

parseString

setTokenHook

read

read

read

read

readType

readType

readBegin

readBegin

tryReadBegin

readBegin

readBegin

tryReadBegin

tryReadBeginEnd

tryReadBegin

tryReadBegin

tryReadBeginEnd

tryReadBegin

readToken

readToken

readToken

tryReadToken

tryReadToken

tryReadToken

readNotEnd

tryReadNotEnd

readEnd

readEnd

readEnd

tryReadEnd

tryReadEnd

readEnd

skip

skip

skip

skip

push

tokenAsBeginEnd

printSyntax