com.github.mygreen.supercsv.io

クラス LazyCsvAnnotationBeanWriter<T>

java.lang.Object

org.supercsv.io.AbstractCsvWriter

com.github.mygreen.supercsv.io.AbstractCsvAnnotationBeanWriter<T>

com.github.mygreen.supercsv.io.LazyCsvAnnotationBeanWriter<T>

型パラメータ:

T - マッピング対象のBeanのクラスタイプ

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

Closeable, Flushable, AutoCloseable, ICsvWriter

public class LazyCsvAnnotationBeanWriter<T>
extends AbstractCsvAnnotationBeanWriter<T>

カラムの定義が曖昧なアノテーションを元にCSVファイルを書き出すためのクラス。

カラム番号が指定されていないBean定義を元にマッピングします。

導入されたバージョン:

2.1

バージョン:

2.2

作成者:

T.TSUCHIE

フィールドのサマリー

クラスから継承されたフィールド com.github.mygreen.supercsv.io.AbstractCsvAnnotationBeanWriter

beanMappingCache, beanValues, cache, errorMessages, exceptionConverter, processedColumns, validators

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

コンストラクタ

コンストラクタと説明
LazyCsvAnnotationBeanWriter(BeanMapping<T> beanMapping, Writer writer, CsvPreference preference, Class<?>... groups) Beanのマッピング情報を指定して、LazyCsvAnnotationBeanWriterを作成するコンストラクタ。
LazyCsvAnnotationBeanWriter(Class<T> beanType, Writer writer, CsvPreference preference, Class<?>... groups) Beanのクラスタイプを指定して、LazyCsvAnnotationBeanWriterを作成するコンストラクタ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
BeanMapping<T>	getBeanMapping() Beanのマッピング情報を取得します。
String[]	getDefinedHeader() Beanクラスを元に作成したヘッダー情報を取得する。
void	init() ヘッダー情報を指定しないで初期化を行います。
void	init(String... headers) ヘッダー情報を指定して初期化を行います。
void	write(T source) レコードを書き込みます。
void	writeAll(Collection<T> sources) レコードのデータを全て書き込みます。
void	writeAll(Collection<T> sources, boolean continueOnError) レコードのデータを全て書き込みます。
void	writeHeader() ヘッダー情報を書き出します。

クラスから継承されたメソッド com.github.mygreen.supercsv.io.AbstractCsvAnnotationBeanWriter

addValidator, executeCellProcessors, executeNonCellProcessor, extractBeanValues, getErrorMessages, getExceptionConverter, getValidators, processErrors, setExceptionConverter, write

クラスから継承されたメソッド org.supercsv.io.AbstractCsvWriter

close, flush, getLineNumber, getRowNumber, incrementRowAndLineNo, writeComment, writeHeader, writeRow, writeRow, writeRow

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

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

コンストラクタの詳細

LazyCsvAnnotationBeanWriter

public LazyCsvAnnotationBeanWriter(Class<T> beanType,
                                   Writer writer,
                                   CsvPreference preference,
                                   Class<?>... groups)

Beanのクラスタイプを指定して、LazyCsvAnnotationBeanWriterを作成するコンストラクタ。

BufferedWriterにラップして実行されるため、ラップする必要はありません。

パラメータ:

beanType - Beanのクラスタイプ。

writer - the writer

preference - CSV preferences.

groups - グループ情報。適用するアノテーションを切り替える際に指定します。

例外:

NullPointerException - if beanType or writer or preferences are null.

LazyCsvAnnotationBeanWriter

public LazyCsvAnnotationBeanWriter(BeanMapping<T> beanMapping,
                                   Writer writer,
                                   CsvPreference preference,
                                   Class<?>... groups)

Beanのマッピング情報を指定して、LazyCsvAnnotationBeanWriterを作成するコンストラクタ。

BufferedWriterにラップして実行されるため、ラップする必要はありません。

Beanのマッピング情報を独自にカスタマイズして、LazyBeanMappingFactoryから作成する場合に利用します。

パラメータ:

beanMapping - Beanのマッピング情報。

writer - the writer

preference - the CSV preferences.

例外:

NullPointerException - if beanMapping or writer or preferences are null.

メソッドの詳細

init

public void init()

ヘッダー情報を指定しないで初期化を行います。

カラム番号が指定されていないカラムは、フィールドの名称順に空いている番号が割り振られます。

init

public void init(String... headers)

ヘッダー情報を指定して初期化を行います。

カラム番号が指定されていないカラムは、フィールドの名称順に空いている番号が割り振られます。

パラメータ:

headers - ヘッダー情報

writeHeader

public void writeHeader()
                 throws IOException

ヘッダー情報を書き出します。

ただし、列番号を省略され、定義がされていないカラムは、column[カラム番号]の形式となります。

例外:

IOException - ファイルの出力に失敗した場合。

IllegalStateException - init() メソッドによる初期化が完了していない場合

writeAll

public void writeAll(Collection<T> sources)
              throws IOException

レコードのデータを全て書き込みます。

ヘッダー行も自動的に処理されます。2回目以降に呼び出した場合、ヘッダー情報は書き込まれません。

レコード処理中に例外が発生した場合、その時点で処理を終了します。

パラメータ:

sources - 書き込むレコードのデータ。

例外:

NullPointerException - sources is null.

IOException - レコードの出力に失敗した場合。

SuperCsvBindingException - セルの値に問題がある場合

SuperCsvException - 設定など、その他に問題がある場合

writeAll

public void writeAll(Collection<T> sources,
                     boolean continueOnError)
              throws IOException

レコードのデータを全て書き込みます。

ヘッダー行も自動的に処理されます。2回目以降に呼び出した場合、ヘッダー情報は書き込まれません。

パラメータ:

sources - 書き込むレコードのデータ。

continueOnError - continueOnError レコードの処理中に、 例外SuperCsvBindingExceptionが発生しても、続行するかどうか指定します。 trueの場合、例外が発生しても、次の処理を行います。

例外:

NullPointerException - sources is null.

IOException - レコードの出力に失敗した場合。

SuperCsvBindingException - セルの値に問題がある場合

SuperCsvException - 設定など、その他に問題がある場合

write

public void write(T source)
           throws IOException

レコードを書き込みます。

オーバーライド:

write クラス内 AbstractCsvAnnotationBeanWriter<T>

パラメータ:

source - 書き込むレコード。

例外:

IllegalStateException - init() メソッドによる初期化が完了していない場合

IOException - レコードの出力に失敗した場合。

getDefinedHeader

public String[] getDefinedHeader()

Beanクラスを元に作成したヘッダー情報を取得する。

ただし、列番号を省略され、定義がされていないカラムは、column[カラム番号]の形式となります。

オーバーライド:

getDefinedHeader クラス内 AbstractCsvAnnotationBeanWriter<T>

戻り値:

ヘッダー一覧。

例外:

IllegalStateException - init() メソッドによる初期化が完了していない場合

getBeanMapping

public BeanMapping<T> getBeanMapping()

Beanのマッピング情報を取得します。

オーバーライド:

getBeanMapping クラス内 AbstractCsvAnnotationBeanWriter<T>

戻り値:

Beanのマッピング情報

例外:

IllegalStateException - init() メソッドによる初期化が完了していない場合