ParseHelper (JP1/AJS2 Unitdef 2.7.0-RELEASE API)

java.lang.Object
- org.unclazz.jp1ajs2.unitdef.parser.ParseHelper

```
public final class ParseHelper
extends Object
```
各種トークンを読み取るためのヘルパー・メソッドを提供するオブジェクト.

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

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

ParseHelper()

ParseHelper(ParseOptions options)

コンストラクタ
コンストラクタと説明
`ParseHelper()`
`ParseHelper(ParseOptions options)`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`check(Input in, char expected)` 現在位置の文字が期待通りの文字かチェックする.
`void`	`checkNext(Input in, char expected)` 現在位置の次の文字が期待通りの文字かチェックする.
`void`	`checkWord(Input in, String expected)` 現在位置から始まる文字列が期待通りの文字列で始まるかどうかチェックする.
`String`	`parseAbc(Input in)` `'A'`から`'Z'`もしくは`'a'`から`'z'`のいずれかのみで構成される文字列を読み取って返す.
`String`	`parseAbc123_$(Input in)` `'A'`から`'Z'`、`'a'`から`'z'`、 `'0'`から`'9'`もしくは`'_'`と`'$'`のいずれかのみで構成される文字列を読み取って返す.
`String`	`parseAbc123(Input in)` `'A'`から`'Z'`、`'a'`から`'z'` もしくは`'0'`から`'9'`のいずれかのみで構成される文字列を読み取って返す.
`Double`	`parseNumber(Input in)` 浮動小数点数を読み取って返す.
`String`	`parseQuotedString(Input in)` 引用符で囲われた文字列を読み取って返す.
`String`	`parseRawString(Input in)` 空白文字以外から構成される文字列を読み取って返す.
`String`	`parseUntil(Input in, char c0)` 引数で指定された文字が現れる前の文字列を読み取ってを返す.
`String`	`parseUntil(Input in, char c0, char c1)` 引数で指定された文字が現れる前の文字列を読み取ってを返す.
`String`	`parseUntil(Input in, char c0, char c1, char c2)` 引数で指定された文字が現れる前の文字列を読み取ってを返す.
`void`	`skipComment(Input in)` コメントをスキップする.
`void`	`skipWhitespace(Input in)` 空白文字をスキップする.
`void`	`skipWhitespaceWith(Input in, char ch)` 引数で指定された文字とともに空白文字をスキップする.
`void`	`skipWhitespaceWith(Input in, char ch0, char ch1)` 引数で指定された文字とともに空白文字をスキップする.
`void`	`skipWhitespaceWith(Input in, char ch0, char ch1, char ch2)` 引数で指定された文字とともに空白文字をスキップする.
`void`	`skipWord(Input in, String word)` 引数で指定された文字列をスキップする.

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

- コンストラクタの詳細
  - ParseHelper
```
public ParseHelper()
```
  - ParseHelper
```
public ParseHelper(ParseOptions options)
```
- メソッドの詳細
  - skipWhitespace
```
public void skipWhitespace(Input in)
                    throws ParseException
```
    空白文字をスキップする. スキップされた文字がない場合でもエラーとはしない。 ParseOptions.skipCommentWithWhitespaceがtrueの場合コメントもスキップする。
    
    パラメータ:
    
    in - 入力データ
    
    例外:
    
    ParseException - 空白文字のスキップ中にエラーが発生した場合
  - skipWhitespaceWith
```
public void skipWhitespaceWith(Input in,
                               char ch)
                        throws ParseException
```
    引数で指定された文字とともに空白文字をスキップする. スキップされた文字がない場合（現在読み取り位置が引数で指定された文字や空白文字でない場合）でもエラーとはしない。
    
    パラメータ:
    
    in - 入力データ
    
    ch - スキップ対象文字
    
    例外:
    
    ParseException - 空白文字のスキップ中にエラーが発生した場合
  - skipWhitespaceWith
```
public void skipWhitespaceWith(Input in,
                               char ch0,
                               char ch1)
                        throws ParseException
```
    引数で指定された文字とともに空白文字をスキップする. スキップされた文字がない場合（現在読み取り位置が引数で指定された文字や空白文字でない場合）でもエラーとはしない。
    
    パラメータ:
    
    in - 入力データ
    
    ch0 - スキップ対象文字
    
    ch1 - スキップ対象文字
    
    例外:
    
    ParseException - 空白文字のスキップ中にエラーが発生した場合
  - skipWhitespaceWith
```
public void skipWhitespaceWith(Input in,
                               char ch0,
                               char ch1,
                               char ch2)
                        throws ParseException
```
    引数で指定された文字とともに空白文字をスキップする. スキップされた文字がない場合（現在読み取り位置が引数で指定された文字や空白文字でない場合）でもエラーとはしない。
    
    パラメータ:
    
    in - 入力データ
    
    ch0 - スキップ対象文字
    
    ch1 - スキップ対象文字
    
    ch2 - スキップ対象文字
    
    例外:
    
    ParseException - 空白文字のスキップ中にエラーが発生した場合
  - skipComment
```
public void skipComment(Input in)
                 throws ParseException
```
    コメントをスキップする. スキップされた文字がない場合でもエラーとはしない。
    
    パラメータ:
    
    in - 入力データ
    
    例外:
    
    ParseException - コメントのスキップ中にエラーが発生した場合
  - skipWord
```
public void skipWord(Input in,
                     String word)
              throws ParseException
```
    引数で指定された文字列をスキップする. 読み取り位置に指定された文字列が見つからなかった場合エラーとする。
    
    パラメータ:
    
    in - 入力データ
    
    word - スキップする文字列
    
    例外:
    
    ParseException - 文字列のスキップ中にエラーが発生した場合
  - parseRawString
```
public String parseRawString(Input in)
                      throws ParseException
```
    空白文字以外から構成される文字列を読み取って返す.
    
    パラメータ:
    
    in - 入力データ
    
    戻り値:
    
    読み取り結果
    
    例外:
    
    ParseException - 文字列の読み取り中にエラーが発生した場合
  - parseNumber
```
public Double parseNumber(Input in)
                   throws ParseException
```
    浮動小数点数を読み取って返す.
    
    パラメータ:
    
    in - 入力データ
    
    戻り値:
    
    浮動小数点数
    
    例外:
    
    ParseException - 浮動小数点数の読み取り中にエラーが発生した場合
  - parseUntil
```
public String parseUntil(Input in,
                         char c0)
                  throws ParseException
```
    引数で指定された文字が現れる前の文字列を読み取ってを返す.
    
    パラメータ:
    
    in - 入力データ
    
    c0 - 読み取りを終える文字
    
    戻り値:
    
    読み取り結果
    
    例外:
    
    ParseException - 文字列の読み取り中にエラーが発生した場合
  - parseUntil
```
public String parseUntil(Input in,
                         char c0,
                         char c1)
                  throws ParseException
```
    引数で指定された文字が現れる前の文字列を読み取ってを返す.
    
    パラメータ:
    
    in - 入力データ
    
    c0 - 読み取りを終える文字
    
    c1 - 読み取りを終える文字
    
    戻り値:
    
    読み取り結果
    
    例外:
    
    ParseException - 文字列の読み取り中にエラーが発生した場合
  - parseUntil
```
public String parseUntil(Input in,
                         char c0,
                         char c1,
                         char c2)
                  throws ParseException
```
    引数で指定された文字が現れる前の文字列を読み取ってを返す.
    
    パラメータ:
    
    in - 入力データ
    
    c0 - 読み取りを終える文字
    
    c1 - 読み取りを終える文字
    
    c2 - 読み取りを終える文字
    
    戻り値:
    
    読み取り結果
    
    例外:
    
    ParseException - 文字列の読み取り中にエラーが発生した場合
  - parseAbc
```
public String parseAbc(Input in)
                throws ParseException
```
    'A'から'Z'もしくは'a'から'z'のいずれかのみで構成される文字列を読み取って返す.
    
    パラメータ:
    
    in - 入力データ
    
    戻り値:
    
    読み取り結果
    
    例外:
    
    ParseException - 文字列の読み取り中にエラーが発生した場合
  - parseAbc123
```
public String parseAbc123(Input in)
                   throws ParseException
```
    'A'から'Z'、'a'から'z' もしくは'0'から'9'のいずれかのみで構成される文字列を読み取って返す.
    
    パラメータ:
    
    in - 入力データ
    
    戻り値:
    
    読み取り結果
    
    例外:
    
    ParseException - 文字列の読み取り中にエラーが発生した場合
  - parseAbc123_$
```
public String parseAbc123_$(Input in)
                     throws ParseException
```
    'A'から'Z'、'a'から'z'、 '0'から'9'もしくは'_'と'$'のいずれかのみで構成される文字列を読み取って返す.
    
    パラメータ:
    
    in - 入力データ
    
    戻り値:
    
    読み取り結果
    
    例外:
    
    ParseException - 文字列の読み取り中にエラーが発生した場合
  - parseQuotedString
```
public String parseQuotedString(Input in)
                         throws ParseException
```
    引用符で囲われた文字列を読み取って返す.
    
    パラメータ:
    
    in - 入力データ
    
    戻り値:
    
    読み取り結果
    
    例外:
    
    ParseException - 文字列の読み取り中にエラーが発生した場合
  - check
```
public void check(Input in,
                  char expected)
           throws ParseException
```
    現在位置の文字が期待通りの文字かチェックする.
    
    パラメータ:
    
    in - 入力データ
    
    expected - 期待される文字
    
    例外:
    
    ParseException - 期待通りでなかった場合
  - checkNext
```
public void checkNext(Input in,
                      char expected)
               throws ParseException
```
    現在位置の次の文字が期待通りの文字かチェックする. チェックにともない現在位置が1前進する。
    
    パラメータ:
    
    in - 入力データ
    
    expected - 期待される文字
    
    例外:
    
    ParseException - 期待通りでなかった場合
  - checkWord
```
public void checkWord(Input in,
                      String expected)
               throws ParseException
```
    現在位置から始まる文字列が期待通りの文字列で始まるかどうかチェックする. チェックにともなう現在位置移動は発生しない。
    
    パラメータ:
    
    in - 入力データ
    
    expected - 期待される文字列
    
    例外:
    
    ParseException - 期待通りでなかった場合

クラス ParseHelper

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

メソッドのサマリー

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

コンストラクタの詳細

ParseHelper

ParseHelper

メソッドの詳細

skipWhitespace

skipWhitespaceWith

skipWhitespaceWith

skipWhitespaceWith

skipComment

skipWord

parseRawString

parseNumber

parseUntil

parseUntil

parseUntil

parseAbc

parseAbc123

parseAbc123_$

parseQuotedString

check

checkNext

checkWord