CsvReader (OrangeSignal CSV 2.2.2-SNAPSHOT API)

java.lang.Object
- com.orangesignal.csv.CsvReader

すべての実装されたインタフェース:

Closeable, AutoCloseable
```
public class CsvReader
extends Object
implements Closeable
```
区切り文字形式入力ストリームを提供します。

作成者:

Koji Sugisawa

関連項目:
RFC-4180 Common Format and MIME Type for Comma-Separated Values (CSV) Files

コンストラクタの概要

コンストラクタ
コンストラクタと説明
`CsvReader(Reader in)` デフォルトのバッファーサイズとデフォルトの区切り文字形式情報を使用して、このクラスを構築するコンストラクタです。
`CsvReader(Reader in, CsvConfig cfg)` デフォルトのバッファーサイズと指定された区切り文字形式情報を使用して、このクラスを構築するコンストラクタです。
`CsvReader(Reader in, int sz)` 指定されたバッファーサイズとデフォルトの区切り文字形式情報を使用して、このクラスを構築するコンストラクタです。
`CsvReader(Reader in, int sz, CsvConfig cfg)` 指定されたバッファーサイズと指定された区切り文字形式情報を使用して、このクラスを構築するコンストラクタです。

メソッドの概要

メソッド
修飾子とタイプ	メソッドと説明
`void`	`close()`
`int`	`getEndLineNumber()` 終了物理行番号の現在値を取得します。
`int`	`getLineNumber()` 論理行番号の現在値を取得します。
`int`	`getStartLineNumber()` 開始物理行番号の現在値を取得します。
`boolean`	`isEndOfFile()` ファイルの終わりに達したかどうかを取得します。
`List<CsvToken>`	`readTokens()` 論理行を読込み区切り文字形式データトークンをリストして返します。
`List<String>`	`readValues()` 論理行を読込み区切り文字形式データトークンの値をリストして返します。

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

- コンストラクタの詳細
  - CsvReader
```
public CsvReader(Reader in,
         int sz,
         CsvConfig cfg)
```
    指定されたバッファーサイズと指定された区切り文字形式情報を使用して、このクラスを構築するコンストラクタです。
    
    パラメータ:
    in - 文字入力ストリーム
    sz - 入力バッファのサイズ
    cfg - 区切り文字形式情報
    
    例外:
    
    IllegalArgumentException - sz が 0 以下の場合。または、cfg が null の場合。または、cfg の区切り文字および囲み文字、エスケープ文字の組合せが不正な場合
  - CsvReader
```
public CsvReader(Reader in,
         CsvConfig cfg)
```
    デフォルトのバッファーサイズと指定された区切り文字形式情報を使用して、このクラスを構築するコンストラクタです。
    
    パラメータ:
    in - 文字入力ストリーム
    cfg - 区切り文字形式情報
    
    例外:
    
    IllegalArgumentException - cfg が null の場合または、cfg の区切り文字および囲み文字、エスケープ文字の組合せが不正な場合
  - CsvReader
```
public CsvReader(Reader in,
         int sz)
```
    指定されたバッファーサイズとデフォルトの区切り文字形式情報を使用して、このクラスを構築するコンストラクタです。
    
    パラメータ:
    in - 文字入力ストリーム
    sz - 入力バッファのサイズ
    
    例外:
    
    IllegalArgumentException - sz が 0 以下の場合
  - CsvReader
```
public CsvReader(Reader in)
```
    デフォルトのバッファーサイズとデフォルトの区切り文字形式情報を使用して、このクラスを構築するコンストラクタです。
    
    パラメータ:
    in - 文字入力ストリーム
- メソッドの詳細
  - getStartLineNumber
```
public int getStartLineNumber()
```
    開始物理行番号の現在値を取得します。
    
    戻り値:
    現在の開始物理行番号
  - getEndLineNumber
```
public int getEndLineNumber()
```
    終了物理行番号の現在値を取得します。
    
    戻り値:
    現在の終了物理行番号
  - getLineNumber
```
public int getLineNumber()
```
    論理行番号の現在値を取得します。
    
    戻り値:
    現在の論理行番号
  - isEndOfFile
```
public boolean isEndOfFile()
```
    ファイルの終わりに達したかどうかを取得します。
    
    戻り値:
    ファイルの終わりに達したかどうか
    導入されたバージョン:
    
    2.2.1
  - readValues
```
public List<String> readValues()
                        throws IOException
```
    論理行を読込み区切り文字形式データトークンの値をリストして返します。
    このメソッドは利便性のために提供しています。
    
    戻り値:
    区切り文字形式データトークンの値をリスト。ストリームの終わりに達している場合は null
    
    例外:
    
    CsvTokenException - 可変項目数が禁止されている場合に項目数が一致しない場合
    
    IOException - 入出力エラーが発生した場合
  - readTokens
```
public List<CsvToken> readTokens()
                          throws IOException
```
    論理行を読込み区切り文字形式データトークンをリストして返します。
    
    戻り値:
    区切り文字形式データトークンのリスト。ストリームの終わりに達している場合は null
    
    例外:
    
    CsvTokenException - 可変項目数が禁止されている場合に項目数が一致しない場合
    
    IOException - 入出力エラーが発生した場合
  - close
```
public void close()
           throws IOException
```
    定義:
    
    close インタフェース内 Closeable
    
    定義:
    
    close インタフェース内 AutoCloseable
    
    例外:
    
    IOException

クラス CsvReader

コンストラクタの概要

メソッドの概要

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

コンストラクタの詳細

CsvReader

CsvReader

CsvReader

CsvReader

メソッドの詳細

getStartLineNumber

getEndLineNumber

getLineNumber

isEndOfFile

readValues

readTokens

close