Input (JP1/AJS2 Unitdef 2.7.0-RELEASE API)

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

```
public final class Input
extends Object
```
入力データをあらわすオブジェクト.
InputStreamやFileを使って初期化を行った場合は EOFに到達した時点でInputStream.close()を呼び出してストリームをクローズする。

実装の性質上、パース処理中にIOExceptionが発生する可能性がある。この例外が発生した場合、ストリームのクローズを試みた上で、例外をParseExceptionでラップしてスローする。

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`int`	`columnNumber()` 現在読み取り位置のカラム数を返す.
`char`	`current()` 現在読み取り位置の文字を返す.
`static Input`	`fromCharSequence(CharSequence s)` 文字列を使って初期化を行う.
`static Input`	`fromFile(File f)` ファイルを使って初期化を行う.
`static Input`	`fromFile(File f, Charset charset)` ファイルを使って初期化を行う.
`static Input`	`fromReader(Reader r)`
`static Input`	`fromStream(InputStream s)` 入力ストリームを使って初期化を行う.
`static Input`	`fromStream(InputStream s, Charset charset)` 入力ストリームを使って初期化を行う.
`String`	`line()` 現在の行を返す.
`String`	`line(boolean chomp)` 現在の行を返す.
`int`	`lineNumber()` 現在読み取り位置の行数を返す.
`char`	`next()` 読み取り位置を1つ前進させその位置にある文字を返す.
`boolean`	`reachedEOF()` EOFに到達済みかどうかを判定して返す.
`boolean`	`reachedEOL()` 行末に到達済みかどうかを判定して返す.
`String`	`restOfLine()` 現在読み取り位置以降の行末までの文字列を返す.
`String`	`restOfLine(boolean chomp)` 現在読み取り位置以降の行末までの文字列を返す.
`boolean`	`restStartsWith(String prefix)` 現在読み取り位置に引数で指定された文字列があるかどうか判定する（前方一致判定する）.
`boolean`	`unlessEOF()` `reachedEOF()`の反対.
`boolean`	`unlessEOL()` `reachedEOL()`の反対.

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

- メソッドの詳細
  - fromCharSequence
```
public static Input fromCharSequence(CharSequence s)
                              throws InputExeption
```
    文字列を使って初期化を行う.
    
    パラメータ:
    
    s - 文字列
    
    戻り値:
    
    インスタンス
    
    例外:
    
    InputExeption - 初期化中にエラーが発生した場合
  - fromStream
```
public static Input fromStream(InputStream s)
                        throws InputExeption
```
    入力ストリームを使って初期化を行う. キャラクターセットはランタイムのデフォルトを使用する。
    
    パラメータ:
    
    s - 入力ストリーム
    
    戻り値:
    
    インスタンス
    
    例外:
    
    InputExeption - 初期化中にエラーが発生した場合
  - fromStream
```
public static Input fromStream(InputStream s,
                               Charset charset)
                        throws InputExeption
```
    入力ストリームを使って初期化を行う.
    
    パラメータ:
    
    s - 入力ストリーム
    
    charset - キャラクターセット
    
    戻り値:
    
    インスタンス
    
    例外:
    
    InputExeption - 初期化中にエラーが発生した場合
  - fromReader
```
public static Input fromReader(Reader r)
                        throws InputExeption
```
    例外:
    
    InputExeption
  - fromFile
```
public static Input fromFile(File f)
                      throws InputExeption
```
    ファイルを使って初期化を行う. キャラクターセットはランタイムのデフォルトを使用する。
    
    パラメータ:
    
    f - ファイル
    
    戻り値:
    
    インスタンス
    
    例外:
    
    InputExeption - 初期化中にエラーが発生した場合
  - fromFile
```
public static Input fromFile(File f,
                             Charset charset)
                      throws InputExeption
```
    ファイルを使って初期化を行う.
    
    パラメータ:
    
    f - ファイル
    
    charset - キャラクターセット
    
    戻り値:
    
    インスタンス
    
    例外:
    
    InputExeption - 初期化中にエラーが発生した場合
  - current
```
public char current()
```
    現在読み取り位置の文字を返す.
    
    戻り値:
    
    現在読み取り位置の文字
  - columnNumber
```
public int columnNumber()
```
    現在読み取り位置のカラム数を返す. カラム数は添字に1を加算したもの。すなわち現在読み取り位置が行頭の文字の上にある場合このメソッドは1を返す。
    
    戻り値:
    
    カラム数
  - line
```
public String line()
```
    現在の行を返す. EOFに到達済みの場合はnullを返す。このメソッドが返す文字列には行末の改行文字が含まれる。あらかじめ改行文字が除去された文字列が必要な場合はline(boolean)を使用する。
    
    戻り値:
    
    行文字列
  - line
```
public String line(boolean chomp)
```
    現在の行を返す. EOFに到達済みの場合はnullを返す。引数としてtrueを渡すとあらかじめ行末の改行文字が除去された文字列を返す。
    
    パラメータ:
    
    chomp - 行末の改行文字を除去するかどうか
    
    戻り値:
    
    行文字列
  - lineNumber
```
public int lineNumber()
```
    現在読み取り位置の行数を返す.
    
    戻り値:
    
    行数
  - restOfLine
```
public String restOfLine()
```
    現在読み取り位置以降の行末までの文字列を返す. このメソッドが返す文字列には改行文字が含まれる。
    
    戻り値:
    
    現在読み取り位置以降の行末までの文字列
  - restOfLine
```
public String restOfLine(boolean chomp)
```
    現在読み取り位置以降の行末までの文字列を返す. 引数としてtrueを渡すとあらかじめ行末の改行文字が除去された文字列を返す。
    
    パラメータ:
    
    chomp - 行末の改行文字を除去するかどうか
    
    戻り値:
    
    現在読み取り位置以降の行末までの文字列
  - restStartsWith
```
public boolean restStartsWith(String prefix)
```
    現在読み取り位置に引数で指定された文字列があるかどうか判定する（前方一致判定する）. このメソッドの判定結果はInput#restOfLine().startsWith(String)と同じ結果となる。
    
    パラメータ:
    
    prefix - 前方一致判定に使用される文字列
    
    戻り値:
    
    判定結果
  - reachedEOF
```
public boolean reachedEOF()
```
    EOFに到達済みかどうかを判定して返す.
    
    戻り値:
    
    判定結果
  - unlessEOF
```
public boolean unlessEOF()
```
    reachedEOF()の反対.
    
    戻り値:
    
    判定結果
  - reachedEOL
```
public boolean reachedEOL()
```
    行末に到達済みかどうかを判定して返す.
    
    戻り値:
    
    判定結果
  - unlessEOL
```
public boolean unlessEOL()
```
    reachedEOL()の反対.
    
    戻り値:
    
    判定結果
  - next
```
public char next()
          throws InputExeption
```
    読み取り位置を1つ前進させその位置にある文字を返す. EOFに到達した場合は''を返す。
    
    戻り値:
    
    読み取り位置の文字
    
    例外:
    
    InputExeption - 入力データ読み取り中にエラーが発生した場合

クラス Input

メソッドのサマリー

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

メソッドの詳細

fromCharSequence

fromStream

fromStream

fromReader

fromFile

fromFile

current

columnNumber

line

line

lineNumber

restOfLine

restOfLine

restStartsWith

reachedEOF

unlessEOF

reachedEOL

unlessEOL

next