com.github.mygreen.supercsv.annotation.conversion

注釈型 CsvRightPad

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

右側にパディングするためのアノテーションです。

基本的な使い方

• 属性 size()で、パディングするサイズを指定します。
  変換対象の文字長が属性size()の値を超える場合、パディングは行いません。
• 属性padChar()でパディング文字を指定することができます。
  デフォルトでは、半角空白がパディング文字です。
• アノテーションCsvTrimと併用する際には、処理結果が互いに変換対象となるため、 属性cases()やgroups()で適用するケースを分けるようにしてください。

 @CsvBean
 public class SampleCsv {
     
     // 値が[10]の場合、結果は、[10   ]となります。
     @CsvColumn(number=1)
     @CsvRightPad(size=5)
     private Integer id;
     
     // パディング文字を変更する場合
     @CsvColumn(number=2)
     @CsvRightPad(size=5, padChar='_')
     private Integer number;
     
     // 書き込み時のみ適用する場合
     @CsvColumn(number=3)
     @CsvTrim(cases=BuildCase.Read)
     @CsvRightPad(size=20, cases=BuildCase.Write)
     private String name;
     
     // getter/setterは省略
 }
 

導入されたバージョン:

2.0

作成者:

T.TSUCHIE

必須要素のサマリー

必須要素

修飾子とタイプ	必須要素と説明
int	size パディングするサイズを指定します。

任意要素のサマリー

任意要素

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

要素の詳細

size

public abstract int size

パディングするサイズを指定します。

値は1以上を設定する必要があります。

戻り値:

パディングのサイズ。

padChar

public abstract char padChar

パディングする際の文字を指定します。

戻り値:

パディングの文字

デフォルト:

32

cases

public abstract BuildCase[] cases

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

戻り値:

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

デフォルト:

{}

groups

public abstract Class<?>[] groups

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

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

戻り値:

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

デフォルト:

{}

order

public abstract int order

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

戻り値:

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

デフォルト:

0