SyntaxElement (OtsuLibrary)

java.lang.Object
- otsu.symphonie.SyntaxElement

```
public class SyntaxElement
extends Object
```
解析結果としてユーザに通知されるデータ
構文定義法、入力解析法などの総合的な説明をパッケージ otsu.symphonieの説明で行ってありますので、まずご覧ください。

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static int`	`AS_JSON` json文字列を得る
`static int`	`AS_XML` xml文字列を得る（デフォルト)
`static int`	`BEGIN` type情報,構文定義(DEF,SEL)の開始
`static int`	`END` type情報,構文定義(DEF,SEL)の終了
`static int`	`EOF` type情報,ソースの終了
`String`	`name` 定義名
`int`	`nest` 構文の階層レベル
`static int`	`NO_INDENT` インデントを付けない
`String`	`text` トークンの場合、トークン文字列
`static int`	`TOKEN` type情報,トークン
`int`	`type` 読み取った情報の種別を表す.
`static int`	`WITH_BEGIN_END` トークンXML表示をタグで囲む.

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

コンストラクタ
コンストラクタと説明

SyntaxElement()
空のデータを作成する.

コンストラクタ
コンストラクタと説明
`SyntaxElement()` 空のデータを作成する.

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`boolean`	`equals(SyntaxElement elm_)` 同値比較.
`boolean`	`isBegin()` 定義の開始であるかを調べる.
`boolean`	`isBegin(String name_)` 指定定義の開始であるかを調べる.
`boolean`	`isEnd()` 定義の終了であるかを調べる
`boolean`	`isEnd(String name_)` 指定定義の終了であるかを調べる
`boolean`	`isFixedToken()` 固定パターンのトークンでかつ、トークン名とテキストが同じか
`boolean`	`isToken()` トークンであるか調べる
`boolean`	`isToken(String name_)` 指定トークンであるか調べる
`boolean`	`mustBegin()` 定義の開始でなければならない。
`boolean`	`mustBegin(String name_)` 指定定義の開始でなければならない。
`boolean`	`mustEnd()` 要素の終了でなければならない。
`boolean`	`mustEnd(String name_)` 指定定義の終了でなければならない。
`boolean`	`mustToken()` トークンでなければならない。
`boolean`	`mustToken(String name_)` 指定定義のトークンでなければならない。
`String`	`toJSONText()` トークン/マークをJsonの文字列にします。
`String`	`toString()` 文字列で情報を得る次のような形式で表示する。
`String`	`toXMLString()` XML文字列にする
`String`	`toXMLString(long option_)` XML形式の文字列にする.

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

- フィールドの詳細
  - BEGIN
```
public static final int BEGIN
```
    type情報,構文定義(DEF,SEL)の開始
    
    関連項目:
    
    定数フィールド値
  - END
```
public static final int END
```
    type情報,構文定義(DEF,SEL)の終了
    
    関連項目:
    
    定数フィールド値
  - TOKEN
```
public static final int TOKEN
```
    type情報,トークン
    
    関連項目:
    
    定数フィールド値
  - EOF
```
public static final int EOF
```
    type情報,ソースの終了
    
    関連項目:
    
    定数フィールド値
  - WITH_BEGIN_END
```
public static final int WITH_BEGIN_END
```
    トークンXML表示をタグで囲む.
    トークンのXML表示時にタグで囲みます。
    これは表示だけであり、通知はあくまで１個のElementで行われます。
    
    関連項目:
    
    定数フィールド値
  - 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文字列を得る（デフォルト)
    
    関連項目:
    
    定数フィールド値
  - type
```
public int type
```
    読み取った情報の種別を表す.
    BEGIN,END,TOKEN,EOFの何れかである。
  - name
```
public String name
```
    定義名
  - text
```
public String text
```
    トークンの場合、トークン文字列
  - nest
```
public int nest
```
    構文の階層レベル
- コンストラクタの詳細
  - SyntaxElement
```
public SyntaxElement()
```
    空のデータを作成する.
    SyntaxReaderのread()関数で情報を得るために予め空のデータを作ります。
- メソッドの詳細
  - equals
```
public boolean equals(SyntaxElement elm_)
```
    同値比較.
    
    パラメータ:
    
    elm_ - 比較対象
    
    戻り値:
    
    真：一致、偽:一致しない
  - isBegin
```
public boolean isBegin(String name_)
```
    指定定義の開始であるかを調べる.
    
    パラメータ:
    
    name_ - 構文要素名
    
    戻り値:
    
    真：指定の開始要素である。偽：指定の開始要素ではない
  - isBegin
```
public boolean isBegin()
```
    定義の開始であるかを調べる.
    
    戻り値:
    
    真：開始要素である。偽：開始要素ではない
  - mustBegin
```
public boolean mustBegin(String name_)
                  throws Exception
```
    指定定義の開始でなければならない。異なればExceptionを発する.
    構文は予めチェックされていますので、プログラムで改めてチェックする必要はありませんが、プログラムと定義の不整合防ぐためには有効です。
    
    パラメータ:
    
    name_ - 構文要素名
    
    戻り値:
    
    常に真；偽にならずExceptionを投げるため
    
    例外:
    
    Exception - 構文異常
  - mustBegin
```
public boolean mustBegin()
                  throws Exception
```
    定義の開始でなければならない。異なればExceptionを発する.
    構文は予めチェックされていますので、プログラムで改めてチェックする必要はありませんが、プログラムと定義の不整合防ぐためには有効です。
    
    戻り値:
    
    常に真；偽にならずExceptionを投げるため
    
    例外:
    
    Exception - 構文異常
  - isEnd
```
public boolean isEnd(String name_)
```
    指定定義の終了であるかを調べる
    
    パラメータ:
    
    name_ - 構文要素名
    
    戻り値:
    
    真：指定の終了要素である。偽：指定の終了要素ではない
  - isEnd
```
public boolean isEnd()
```
    定義の終了であるかを調べる
    
    戻り値:
    
    真：指定の終了要素である。偽：指定の終了要素ではない
  - mustEnd
```
public boolean mustEnd(String name_)
                throws Exception
```
    指定定義の終了でなければならない。異なればExceptionを発する.
    構文は予めチェックされていますので、プログラムで改めてチェックする必要はありませんが、プログラムと定義の不整合防ぐためには有効です。
    
    パラメータ:
    
    name_ - 構文要素名
    
    戻り値:
    
    常に真；偽にならずExceptionを投げるため
    
    例外:
    
    Exception - 構文異常
  - mustEnd
```
public boolean mustEnd()
                throws Exception
```
    要素の終了でなければならない。異なればExceptionを発する.
    構文は予めチェックされていますので、プログラムで改めてチェックする必要はありませんが、プログラムと定義の不整合防ぐためには有効です。
    
    戻り値:
    
    常に真；偽にならずExceptionを投げるため
    
    例外:
    
    Exception - 構文異常
  - isToken
```
public boolean isToken(String name_)
```
    指定トークンであるか調べる
    
    パラメータ:
    
    name_ - トークン名
    
    戻り値:
    
    真：指定のトークンである。偽：指定のトークンではない
  - isToken
```
public boolean isToken()
```
    トークンであるか調べる
    
    戻り値:
    
    真：指定のトークンである。偽：指定のトークンではない
  - mustToken
```
public boolean mustToken(String name_)
                  throws Exception
```
    指定定義のトークンでなければならない。異なればExceptionを発する.
    構文は予めチェックされていますので、プログラムで改めてチェックする必要はありませんが、プログラムと定義の不整合防ぐためには有効です。
    
    パラメータ:
    
    name_ - トークン名
    
    戻り値:
    
    常に真；偽にならずExceptionを投げるため
    
    例外:
    
    Exception - 構文異常
  - mustToken
```
public boolean mustToken()
                  throws Exception
```
    トークンでなければならない。異なればExceptionを発する.
    構文は予めチェックされていますので、プログラムで改めてチェックする必要はありませんが、プログラムと定義の不整合防ぐためには有効です。
    
    戻り値:
    
    常に真；偽にならずExceptionを投げるため
    
    例外:
    
    Exception - 構文異常
  - toString
```
public String toString()
```
    文字列で情報を得る
    次のような形式で表示する。
```
 [BEGIN:名前]
 [END:名前]
 [TOKEN:トークン名:内容]
 [EOF]
```
    オーバーライド:
    
    toString クラス内 Object
    
    戻り値:
    
    文字列表現
  - toXMLString
```
public String toXMLString(long option_)
```
    XML形式の文字列にする.
    
    パラメータ:
    
    option_ - WITH_BEGIN_END指定が可能です。
    
    戻り値:
    
    XML形式の文字列
  - toJSONText
```
public String toJSONText()
```
    トークン/マークをJsonの文字列にします。
    
    戻り値:
    
    Json文字列
  - isFixedToken
```
public boolean isFixedToken()
```
    固定パターンのトークンでかつ、トークン名とテキストが同じか
    
    戻り値:
    
    トークン名とテキストが同じ
  - toXMLString
```
public String toXMLString()
```
    XML文字列にする
    
    戻り値:
    
    XML文字列

クラス SyntaxElement

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

BEGIN

END

TOKEN

EOF

WITH_BEGIN_END

NO_INDENT

AS_JSON

AS_XML

type

name

text

nest

コンストラクタの詳細

SyntaxElement

メソッドの詳細

equals

isBegin

isBegin

mustBegin

mustBegin

isEnd

isEnd

mustEnd

mustEnd

isToken

isToken

mustToken

mustToken

toString

toXMLString

toJSONText

isFixedToken

toXMLString