com.github.mygreen.supercsv.annotation.conversion

注釈型 CsvNullConvert

@Target(value={FIELD,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
 @Documented
 @Repeatable(value=CsvNullConvert.List.class)
 @CsvConversion(value={})
public @interface CsvNullConvert

指定した値と一致したときにnullに変換するためのアノテーションです。

基本的な使い方

• 属性value()で、変換対象の値を指定します。
  複数指定可能です。
• 比較する際に、大文字・小文字の区別を付けたくない場合は、属性ignoreCase()の値をtrueにします。
• アノテーションCsvDefaultValueと併用する際には、処理結果が互いに変換対象となるため、 属性cases()やgroups()で適用するケースを分けるようにしてください。

 @CsvBean
 public class SampleCsv {
     
     // 複数指定可能です
     @CsvColumn(number=1)
     @CsvNullConvert({"-", "N/A"})
     private Integer value;
     
     // 大文字・小文字の区別を行わない場合
     @CsvColumn(number=2)
     @CsvNullConvert(value={"-", "N/A"}, ignoreCase=true)
     private Integer salary;
     
     // 読み込み時のみ適用する場合
     @CsvColumn(number=3)
     @CsvNullConvert(value="-", cases=BuildCase.Read)
     private String comment;
     
     // getter/setterは省略
 }
 

導入されたバージョン:

2.0

作成者:

T.TSUCHIE

必須要素のサマリー

必須要素

修飾子とタイプ	必須要素と説明
String[]	value 変換対象の値を指定します。

任意要素のサマリー

任意要素

修飾子とタイプ	任意要素と説明
BuildCase[]	cases 適用するケースを指定します。
Class<?>[]	groups グループのクラスを指定します。
boolean	ignoreCase 値を比較する際に大文字・小文字の区別を行わないかどうか指定します。

要素の詳細

value

public abstract String[] value

変換対象の値を指定します。

戻り値:

変換対象となる値を指定します。

ignoreCase

public abstract boolean ignoreCase

値を比較する際に大文字・小文字の区別を行わないかどうか指定します。

戻り値:

trueの場合、大文字・小文字の区別を行いません。

デフォルト:

false

cases

public abstract BuildCase[] cases

適用するケースを指定します。

戻り値:

何も指定しない場合は全てのケースに適用されます。

デフォルト:

{}

groups

public abstract Class<?>[] groups

グループのクラスを指定します。

処理ごとに適用するアノテーションを切り替えたい場合に指定します。

戻り値:

指定しない場合は、DefaultGroupが適用され全ての処理に適用されます。

デフォルト:

{}