com.github.mygreen.supercsv.annotation.conversion

注釈型 CsvMultiPad

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

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

アノテーション CsvLeftPadやCsvRightPadより、柔軟に指定ができます。

基本的な使い方

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

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

導入されたバージョン:

2.1

作成者:

T.TSUCHIE

必須要素のサマリー

必須要素

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

任意要素のサマリー

任意要素

修飾子とタイプ	任意要素と説明
BuildCase[]	cases 適用するケースを指定します。
boolean	chopped 指定したカラムの長さを超えた場合、切り出すかどうか指定します。
Class<?>[]	groups グループのクラスを指定します。
int	order アノテーションの処理順序の定義。
char	padChar パディングする際の文字を指定します。
Class<? extends PaddingProcessor>	paddingProcessor パディングの処理方法を指定します。
boolean	rightAlign 右寄せをするかどうか指定します。

要素の詳細

size

public abstract int size

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

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

カラムのサイズは考え型によってバイト数、文字幅など異なるため、 属性paddingProcessor()によって、変更することができます。

戻り値:

パディングのサイズ

padChar

public abstract char padChar

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

戻り値:

パディングの文字。

デフォルト:

32

rightAlign

public abstract boolean rightAlign

右寄せをするかどうか指定します。
falseの場合は、左詰めです。

戻り値:

trueのときは右側に詰め、パディング文字は左側に追加されます。

デフォルト:

false

chopped

public abstract boolean chopped

指定したカラムの長さを超えた場合、切り出すかどうか指定します。

戻り値:

指定したカラムの長さを超えた場合、切り出すかどうか。

デフォルト:

false

paddingProcessor

public abstract Class<? extends PaddingProcessor> paddingProcessor

パディングの処理方法を指定します。

PaddingProcessorを実装したクラス指定します。

戻り値:

パディング処理の実装クラスを指定します。

デフォルト:

com.github.mygreen.supercsv.cellprocessor.conversion.SimplePaddingProcessor.class

cases

public abstract BuildCase[] cases

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

戻り値:

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

デフォルト:

{}

groups

public abstract Class<?>[] groups

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

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

戻り値:

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

デフォルト:

{}

order

public abstract int order

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

戻り値:

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

デフォルト:

0