com.github.mygreen.supercsv.annotation.conversion

注釈型 CsvTruncate

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

指定した最大文字長よりも長い場合、先頭から最大文字長分切り取るためのアノテーションです。

例えば、入力が「あいうえお」の場合、最大文字長を3、接尾語を「...」と指定したとき、「あいう...」という値となります。

基本的な使い方

• 属性 maxSize()で、最大文字長を指定します。
• 属性suffix()で切り取り後に付与する接尾語を指定します。省略可能です。

 @CsvBean
 public class SampleCsv {
     
     @CsvColumn(number=1)
     @CsvTruncate(maxSize=20, suffix="...")
     private String comment;
     
     
     // getter/setterは省略
 }
 

導入されたバージョン:

2.0

作成者:

T.TSUCHIE

必須要素のサマリー

必須要素

修飾子とタイプ	必須要素と説明
int	maxSize 最大文字長を指定します。

任意要素のサマリー

任意要素

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

要素の詳細

maxSize

public abstract int maxSize

最大文字長を指定します。

1以上の値を指定します。

戻り値:

最大文字長。

suffix

public abstract String suffix

切り取り後に付与する接尾語を指定します。

戻り値:

接尾語。

デフォルト:

""

cases

public abstract BuildCase[] cases

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

戻り値:

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

デフォルト:

{}

groups

public abstract Class<?>[] groups

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

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

戻り値:

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

デフォルト:

{}

order

public abstract int order

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

戻り値:

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

デフォルト:

0