com.orangesignal.csv.io

クラス CsvEntityReader<T>

java.lang.Object

com.orangesignal.csv.io.CsvEntityReader<T>

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

Closeable, AutoCloseable

public class CsvEntityReader<T>
extends Object
implements Closeable

区切り文字形式データ注釈要素 CsvEntity で注釈付けされた Java プログラム要素で区切り文字形式データアクセスを行う区切り文字形式入力ストリームを提供します。

導入されたバージョン:

1.4.0

作成者:

Koji Sugisawa

コンストラクタの概要

コンストラクタ

コンストラクタと説明
CsvEntityReader(CsvReader reader, Class<T> entityClass) 指定された区切り文字形式入力ストリームと Java プログラム要素の型を使用して、このクラスを構築するコンストラクタです。
CsvEntityReader(CsvReader reader, CsvEntityTemplate<T> template) 指定された区切り文字形式入力ストリームと Java プログラム要素操作の簡素化ヘルパーを使用して、このクラスを構築するコンストラクタです。

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
void	close()
List<String>	getHeader() 項目名のリストを返します。
CsvEntityTemplate<T>	getTemplate() Java プログラム要素操作の簡素化ヘルパーを返します。
static <T> CsvEntityReader<T>	newInstance(CsvReader reader, Class<T> entityClass) 新しい CsvEntityReader のインスタンスを返します。
static <T> CsvEntityReader<T>	newInstance(CsvReader reader, CsvEntityTemplate<T> template) 新しい CsvEntityReader のインスタンスを返します。
T	read() 論理行を読込み Java プログラム要素として返します。
List<String>	readValues() 論理行を読込み CSV トークンの値をリストとして返します。
T	toEntity(List<String> values) 指定された CSV トークンの値をリストを Java プログラム要素へ変換して返します。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

CsvEntityReader

public CsvEntityReader(CsvReader reader,
               Class<T> entityClass)

指定された区切り文字形式入力ストリームと Java プログラム要素の型を使用して、このクラスを構築するコンストラクタです。

パラメータ:

reader - 区切り文字形式入力ストリーム

entityClass - 区切り文字形式データ注釈要素 CsvEntity で注釈付けされた Java プログラム要素の型

例外:

IllegalArgumentException - reader または entityClass が null の場合。

CsvEntityReader

public CsvEntityReader(CsvReader reader,
               CsvEntityTemplate<T> template)

指定された区切り文字形式入力ストリームと Java プログラム要素操作の簡素化ヘルパーを使用して、このクラスを構築するコンストラクタです。

パラメータ:

reader - 区切り文字形式入力ストリーム

template - Java プログラム要素操作の簡素化ヘルパー

例外:

IllegalArgumentException - reader または template が null の場合。

メソッドの詳細

newInstance

public static <T> CsvEntityReader<T> newInstance(CsvReader reader,
                                 Class<T> entityClass)

新しい CsvEntityReader のインスタンスを返します。 このメソッドは利便性のために提供しています。

パラメータ:

reader - 区切り文字形式入力ストリーム

entityClass - 区切り文字形式データ注釈要素 CsvEntity で注釈付けされた Java プログラム要素の型

戻り値:

新しい CsvEntityReader のインスタンス

例外:

IllegalArgumentException - reader または entityClass が null の場合。

newInstance

public static <T> CsvEntityReader<T> newInstance(CsvReader reader,
                                 CsvEntityTemplate<T> template)

新しい CsvEntityReader のインスタンスを返します。 このメソッドは利便性のために提供しています。

パラメータ:

reader - 区切り文字形式入力ストリーム

template - Java プログラム要素操作の簡素化ヘルパー

戻り値:

新しい CsvEntityReader のインスタンス

例外:

IllegalArgumentException - reader または template が null の場合。

close

public void close()
           throws IOException

定義:

close インタフェース内 Closeable

定義:

close インタフェース内 AutoCloseable

例外:

IOException

getHeader

public List<String> getHeader()
                       throws IOException

項目名のリストを返します。

戻り値:

項目名のリスト

例外:

IOException - 入出力エラーが発生した場合

read

public T read()
       throws IOException

論理行を読込み Java プログラム要素として返します。

戻り値:

Java プログラム要素。ストリームの終わりに達した場合は null

例外:

CsvColumnException - 区切り文字形式のデータ項目の検証操作実行中にエラーが発生した場合

IOException - 入出力エラーが発生した場合

readValues

public List<String> readValues()
                        throws IOException

論理行を読込み CSV トークンの値をリストとして返します。

戻り値:

CSV トークンの値をリスト。ストリームの終わりに達している場合は null

例外:

IOException - 入出力エラーが発生した場合

toEntity

public T toEntity(List<String> values)
           throws IOException

指定された CSV トークンの値をリストを Java プログラム要素へ変換して返します。

パラメータ:

values - CSV トークンの値をリスト

戻り値:

変換された Java プログラム要素

例外:

CsvColumnException - 区切り文字形式のデータ項目の検証操作実行中にエラーが発生した場合

IOException - 入出力エラーが発生した場合

getTemplate

public CsvEntityTemplate<T> getTemplate()

Java プログラム要素操作の簡素化ヘルパーを返します。

戻り値:

Java プログラム要素操作の簡素化ヘルパー

導入されたバージョン:

2.1