com.github.mygreen.supercsv.annotation.conversion

注釈型 CsvDefaultValue

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

値がnullの場合に、代替となる値に変換するためのアノテーションです。

基本的な使い方

• 属性 value()で、変換する値を指定します。
• 読み込むときには、それぞれのタイプの書式に沿った形式を指定する必要があります。
  もし、間違った書式で定義した場合は、CSVファイルの値が不正なときと同様にエラーとなります。
• アノテーションCsvNullConvertと併用する際には、処理結果が互いに変換対象となるため、 属性cases()やgroups()で適用するケースを分けるようにしてください。

 @CsvBean
 public class SampleCsv {
     
     // クラスタイプに沿った値を指定します。
     @CsvColumn(number=1)
     @CsvDefalutValue("0")
     private Integer id;
     
     // 書式が指定されている場合は、書式に沿った値を指定します。
     @CsvColumn(number=2)
     @CsvNumberFomat(pattern="#,##0")
     @CsvDefalutValue("1,000")
     private Integer salary;
     
     // 書き込み時のみ適用する場合
     @CsvColumn(number=3)
     @CsvDefalutValue(value="-", cases=BuildCase.Write)
     private String comment;
     
     // getter/setterは省略
 }
 

導入されたバージョン:

2.0

作成者:

T.TSUCHIE

必須要素のサマリー

必須要素

修飾子とタイプ	必須要素と説明
String	value nullの代替となる値を指定します。

任意要素のサマリー

任意要素

修飾子とタイプ	任意要素と説明
BuildCase[]	cases 適用するケースを指定します。
Class<?>[]	groups グループのクラスを指定します。
int	order アノテーションの処理順序の定義。

要素の詳細

value

public abstract String value

nullの代替となる値を指定します。

戻り値:

ブール型、数値や日時型の場合は、アノテーションで指定した書式に沿った値を指定する必要があります。

cases

public abstract BuildCase[] cases

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

戻り値:

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

デフォルト:

{}

groups

public abstract Class<?>[] groups

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

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

戻り値:

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

デフォルト:

{}

order

public abstract int order

アノテーションの処理順序の定義。

戻り値:

値が大きいほど後に実行されます。 値が同じ場合は、アノテーションのクラス名の昇順になります。

デフォルト:

0