com.github.mygreen.supercsv.io

クラス AbstractCsvAnnotationBeanWriter<T>

java.lang.Object

org.supercsv.io.AbstractCsvWriter

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

型パラメータ:

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

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

Closeable, Flushable, AutoCloseable, ICsvWriter

直系の既知のサブクラス:

CsvAnnotationBeanWriter, FixedSizeCsvAnnotationBeanWriter, LazyCsvAnnotationBeanWriter

public abstract class AbstractCsvAnnotationBeanWriter<T>
extends AbstractCsvWriter

アノテーションを元にCSVファイルを書き出すための抽象クラス。

導入されたバージョン:

2.1

バージョン:

2.3

作成者:

T.TSUCHIE

関連項目:

CsvBeanWriter

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected BeanMappingCache<T>	beanMappingCache Beanのマッピング情報のキャッシュ。
protected List<Object>	beanValues temporary storage of bean values
protected MethodCache	cache cache of methods for mapping from fields to columns
protected List<String>	errorMessages processing error messages.
protected CsvExceptionConverter	exceptionConverter exception converter.
protected List<Object>	processedColumns temporary storage of processed columns to be written
protected List<CsvValidator<T>>	validators validator

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

コンストラクタ

コンストラクタと説明
AbstractCsvAnnotationBeanWriter(Writer writer, CsvPreference preference)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addValidator(CsvValidator<T>... validators) レコード用の値を検証するValidatorを追加します。
protected void	executeCellProcessors(List<Object> destination, List<?> source, CellProcessor[] processors, CsvContext context) 行の各カラムの値に対して、CellProcessorを適用します。
protected Object	executeNonCellProcessor(Object value, CsvContext context) CellProcessorを持たないカラムの値を処理します。
protected void	extractBeanValues(Object source, String[] nameMapping) Extracts the bean values, using the supplied name mapping array.
BeanMapping<T>	getBeanMapping() Beanのマッピング情報を取得します。
String[]	getDefinedHeader() Beanクラスを元に作成したヘッダー情報を取得する。
List<String>	getErrorMessages() エラーメッセージを取得します。
CsvExceptionConverter	getExceptionConverter() 処理中に発生した例外をメッセージに変換するクラスを取得します。
List<CsvValidator<T>>	getValidators() レコードの値を検証するValidatorを取得します。
protected void	processErrors(CsvBindingErrors bindingErrors, CsvContext context, Optional<SuperCsvRowException> rowException) 行の例外情報をメッセージに変換したりします。
void	setExceptionConverter(CsvExceptionConverter exceptionConverter) 処理中に発生した例外をメッセージに変換するクラスを設定します。
void	write(T source) レコードを書き込みます。
CsvWriteStatus	write(T source, CsvErrorHandler errorHandler) 例外発生時の処理を指定して、1レコード分を書き込みます。

クラスから継承されたメソッド 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

フィールドの詳細

beanMappingCache

protected BeanMappingCache<T> beanMappingCache

Beanのマッピング情報のキャッシュ。 ・組み立てたCellProcessorをキャッシュしておきます。

beanValues

protected final List<Object> beanValues

temporary storage of bean values

processedColumns

protected final List<Object> processedColumns

temporary storage of processed columns to be written

cache

protected final MethodCache cache

cache of methods for mapping from fields to columns

exceptionConverter

protected CsvExceptionConverter exceptionConverter

exception converter.

errorMessages

protected final List<String> errorMessages

processing error messages.

validators

protected final List<CsvValidator<T>> validators

validator

コンストラクタの詳細

AbstractCsvAnnotationBeanWriter

public AbstractCsvAnnotationBeanWriter(Writer writer,
                                       CsvPreference preference)

メソッドの詳細

write

public void write(T source)
           throws IOException

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

パラメータ:

source - 書き込むレコード。

例外:

NullPointerException - source is null.

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

SuperCsvException - レコードの値に問題がある場合

write

public CsvWriteStatus write(T source,
                            CsvErrorHandler errorHandler)
                     throws IOException

例外発生時の処理を指定して、1レコード分を書き込みます。

パラメータ:

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

errorHandler - CSVに関する例外発生時の処理の実装。

戻り値:

CSVの書き込み処理ステータスを返します。

例外:

IOException

導入されたバージョン:

2.3

processErrors

protected void processErrors(CsvBindingErrors bindingErrors,
                             CsvContext context,
                             Optional<SuperCsvRowException> rowException)

行の例外情報をメッセージに変換したりします。

パラメータ:

bindingErrors -

context -

rowException -

extractBeanValues

protected void extractBeanValues(Object source,
                                 String[] nameMapping)
                          throws SuperCsvReflectionException

Extracts the bean values, using the supplied name mapping array.

パラメータ:

source - the bean

nameMapping - the name mapping

例外:

NullPointerException - if source or nameMapping are null

SuperCsvReflectionException - if there was a reflection exception extracting the bean value

executeCellProcessors

protected void executeCellProcessors(List<Object> destination,
                                     List<?> source,
                                     CellProcessor[] processors,
                                     CsvContext context)

行の各カラムの値に対して、CellProcessorを適用します。

パラメータ:

destination - CellProcessorで処理した結果のカラムの値。

source - CellProcessで処理前のカラムの値。

processors - 適用するCellProcesor。

context - CSVカラム。

executeNonCellProcessor

protected Object executeNonCellProcessor(Object value,
                                         CsvContext context)

CellProcessorを持たないカラムの値を処理します。

パラメータ:

value - 処理前のカラムの値。

context - CSV情報。

戻り値:

処理後のカラムの値。

getDefinedHeader

public String[] getDefinedHeader()

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

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

戻り値:

ヘッダー一覧。

getBeanMapping

public BeanMapping<T> getBeanMapping()

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

戻り値:

Beanのマッピング情報

getErrorMessages

public List<String> getErrorMessages()

エラーメッセージを取得します。

戻り値:

処理中に発生した例外をメッセージに変換した

getExceptionConverter

public CsvExceptionConverter getExceptionConverter()

処理中に発生した例外をメッセージに変換するクラスを取得します。

戻り値:

setExceptionConverter

public void setExceptionConverter(CsvExceptionConverter exceptionConverter)

処理中に発生した例外をメッセージに変換するクラスを設定します。

パラメータ:

exceptionConverter - 独自にカスタマイズした値を設定します。

addValidator

public void addValidator(CsvValidator<T>... validators)

レコード用の値を検証するValidatorを追加します。

パラメータ:

validators - CsvValidatorの実装クラスを設定します。

getValidators

public List<CsvValidator<T>> getValidators()

レコードの値を検証するValidatorを取得します。

戻り値:

CsvValidatorの実装クラスを設定します。