com.github.mygreen.supercsv.annotation

注釈型 CsvBean

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
public @interface CsvBean

CSVのBeanであることを表現するためのアノテーションです。

クラスに付与します。

基本的な使い方

CSVをマッピングするBeanのクラスに付与します。

 @CsvBean
 public class SampleCsv {
     
     @CsvColumn(number=1)
     private int no;
     
     @CsvColumn(number=2, label="名前")
     private String name;
     
     // getter/setterは省略
 }
 

バージョン:

2.1

作成者:

T.TSUCHIE

任意要素のサマリー

任意要素

修飾子とタイプ	任意要素と説明
boolean	header ヘッダーが存在することを前提として処理します。
Class<? extends HeaderMapper>	headerMapper カラムに対するヘッダーラベルを取得方法を指定します。
Class<?>[]	listeners ライフサイクルコールバック用のリスナークラスを指定するためのアノテーション。
boolean	validateHeader ヘッダー行の読み込み時に、値の検証を行うか指定します。
Class<? extends CsvValidator<?>>[]	validators レコードに対する値の検証を行うクラスを指定します。

要素の詳細

header

public abstract boolean header

ヘッダーが存在することを前提として処理します。

CsvAnnotationBeanReader.readAll(boolean)、CsvAnnotationBeanWriter.writeAll(java.util.Collection, boolean)を呼び出した際に利用します。

戻り値:

trueの場合、読み込み時には1行目はヘッダー情報として読み込み、書き出し時にはヘッダー行が出力されるようになります。

デフォルト:

false

validateHeader

public abstract boolean validateHeader

ヘッダー行の読み込み時に、値の検証を行うか指定します。

部分的にカラムの読み込みを行う際、アノテーションCsvPartialで省略した見出しを定義していない場合は、属性の値をfalseに設定してください。

戻り値:

trueの場合、ヘッダー行の値が定義されている値と同じかどうか検証を行います。 ヘッダーの値が不正な場合、例外SuperCsvNoMatchHeaderExceptionがスローされます。

導入されたバージョン:

2.0

デフォルト:

false

headerMapper

public abstract Class<? extends HeaderMapper> headerMapper

カラムに対するヘッダーラベルを取得方法を指定します。

戻り値:

HeaderMapperの実装クラスを指定します。

導入されたバージョン:

2.1

デフォルト:

com.github.mygreen.supercsv.builder.DefaultHeaderMapper.class

validators

public abstract Class<? extends CsvValidator<?>>[] validators

レコードに対する値の検証を行うクラスを指定します。

カラム間の相関チェックやBean Validationを使用する際に指定します。

戻り値:

CsvValidatorを実装したクラスを指定します。 複数指定可能で、指定した順に実行されます。

導入されたバージョン:

2.0

デフォルト:

{}

listeners

public abstract Class<?>[] listeners

ライフサイクルコールバック用のリスナークラスを指定するためのアノテーション。

戻り値:

コールバック用アノテーションを指定したメソッドを指定します。

導入されたバージョン:

2.0

デフォルト:

{}