com.github.mygreen.supercsv.annotation.conversion

注釈型 CsvFixedSize

@Target(value={FIELD,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
 @Documented
 @Repeatable(value=CsvFixedSize.List.class)
 @CsvComposition
 @CsvMultiPad(size=0,
             cases=Write,
             order=1000)
 @CsvOneSideTrim(cases=Read)
public @interface CsvFixedSize

固定長のカラムを表現するためのアノテーションです。

このアノテーションは、次の合成のアノテーションによって、構成されています。

• 書き込み時は、アノテーションCsvMultiPadによって、パディングします。
• 読み込み時は、アノテーションCsvOneSideTrimによって、トリムします。

基本的な使い方

• 属性size()で文字のサイズを指定します。
• 文字のサイズは、カウント方法の考え型によって変わるため、paddingProcessor() で処理方式を指定します。
  例えば、CharWidthPaddingProcessorは、文字の幅（半角文字のサイズ=1、全角文字のサイズ=2）として書き込み時にパディングします。
• 属性rightAlign()によって、右寄せか左寄せか指定します。
  trueのとき右寄せ、falseのとき左よせで、デフォルトは左寄せです。

 @CsvBean
 public class SampleCsv {
     
     // 右詰めする
     @CsvColumn(number=1)
     @CsvFixedSize(size=10, rightAlign=true)
     private Integer value;
     
     // 全角空白で埋める。
     // ただし、文字の幅（半角のサイズ=1、全角のサイズ=2）として処理する。
     @CsvColumn(number=2)
     @CsvFullChar
     @CsvFixedSize(size=20, padChar='　', paddingProcessor=CharWidthPaddingProcessor.class)
     private String userName;
     
     // 他のオブジェクト型への変換を行う
     @CsvColumn(number=3)
     @CsvFixedSize(size=10, padChar='_')
     @CsvDateTimeFormat(pattern="uuuu-MM-dd")
     private LocalDate birthday;
     
     // 指定した文字長を超えた場合、切り落とす。
     @CsvColumn(number=4, label="コメント")
     @CsvFixedSize(size=20, chopped=true)
     private String comment;
     
     // getter/setterは省略
 }
 

導入されたバージョン:

2.1

作成者:

T.TSUCHIE

必須要素のサマリー

必須要素

修飾子とタイプ	必須要素と説明
int	size カラムのサイズを指定します。

任意要素のサマリー

任意要素

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

要素の詳細

size

@CsvOverridesAttribute(annotation=CsvMultiPad.class,
                       name="size")
public abstract int size

カラムのサイズを指定します。

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

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

戻り値:

カラムのサイズ。

padChar

@CsvOverridesAttribute(annotation=CsvMultiPad.class,name="padChar") @CsvOverridesAttribute(annotation=CsvOneSideTrim.class,name="trimChar")
public abstract char padChar

パディングする際の文字を指定します。
読み込み時には、トリム対象の文字となります。

戻り値:

パディング文字。

デフォルト:

32

chopped

@CsvOverridesAttribute(annotation=CsvMultiPad.class,
                       name="chopped")
public abstract boolean chopped

パディング時に指定したカラムの長さを超えた場合、切り出すかどうか指定します。

戻り値:

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

デフォルト:

false

paddingProcessor

@CsvOverridesAttribute(annotation=CsvMultiPad.class,
                       name="paddingProcessor")
public abstract Class<? extends PaddingProcessor> paddingProcessor

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

PaddingProcessorを実装したクラス指定します。
標準では次の実装が提供されています。

• SimplePaddingProcessor：文字の種別にかかわらず１文字としてカウントしてパディングします。
• CharWidthPaddingProcessor：文字の幅（半角は1文字、全角は2文字）によってカウントしてパディングします。
• ByteSizePaddingProcessor：バイト数によってカウントしてパディングします。

戻り値:

パディング処理の実装クラス。

デフォルト:

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

rightAlign

@CsvOverridesAttribute(annotation=CsvMultiPad.class,name="rightAlign") @CsvOverridesAttribute(annotation=CsvOneSideTrim.class,name="leftAlign")
public abstract boolean rightAlign

右寄せをするかどうか指定します。
読み込み時のトリム時は、逆の意味になるので注意。
falseの場合は、左詰めです。

戻り値:

パディング文字が右側にあるかどうか。

デフォルト:

false

groups

public abstract Class<?>[] groups

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

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

戻り値:

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

デフォルト:

{}