com.github.mygreen.supercsv.annotation

注釈型 CsvPreWrite

@Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Documented
public @interface CsvPreWrite

ライフサイクルイベントをハンドリングするためのアノテーションです。

レコードの書き込み前に、このアノテーションを付与した任意のメソッドが実行されます。

• 戻り値なしのpublicメソッドに付与する必要があります。
• 引数は、次の任意の値が指定可能で、定義順は関係ありません。
  引数を取らないことも可能です。

メソッドに指定可能な引数一覧

引数のタイプ	説明
CsvContext	CSVの1レコード分の情報。
CsvBindingErrors	CSVの1レコード分のエラー情報。
Class[]	グループのクラス情報（配列）。
処理対象のBeanクラス。	処理対象のBeanオブジェクト。

実装方法として、JavaBeanに直接処理を実装する方法と、リスナークラスを指定して別のクラスで実装する方法の2種類があります。

JavaBeanクラスに実装する場合

任意のメソッドにアノテーションを付与します。

 @CsvBean
 public class SampleCsv {
     
     @CsvColumn(number=1)
     private String name;
     
     @CsvPreWrite
     public void onPreWrite(CsvContext csvContext, CsvBindingErrors bindingErrors) {
         //任意の処理の実装
         
     }
     
     // getter/setterは省略
 }
 

リスナークラスに実装する場合

POJOであるリスナークラスの任意のメソッドにアノテーションを付与します。

Spring Frameworkと連携している場合、リスナークラスをSpringBeanとして登録しているとでインジェクションできます。

 @CsvBean(listeners=SampleListener.class)  // リスナークラスの指定
 public class SampleCsv {
     
     @CsvColumn(number=1)
     private String name;
     
     // getter/setterは省略
 }
 
 // SampleCsvに対するリスナー
 public static class SampleListener {
 
     @CsvPreWrite
     public void onPreWrite(SampleCsv record, CsvContext csvContext, CsvBindingErrors bindingErrors) {
         //任意の処理の実装
         
     }
 }
 

導入されたバージョン:

2.0

作成者:

T.TSUCHIE