com.github.mygreen.supercsv.annotation.constraint

注釈型 CsvLengthExact

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

文字長が指定した長さと等しいか検証するためのアノテーションです。

文字列型に指定可能です。

基本的な使い方

• 属性value()で、文字長を指定します。
  複数指定した場合は、何れかの文字長に一致すれば問題ありません。

 @CsvBean
 public class SampleCsv {
     
     @CsvColumn(number=1)
     @CsvLengthExact({2, 5, 10})
     private String value;
     
     // getter/setterは省略
 }
 

導入されたバージョン:

2.0

作成者:

T.TSUCHIE

必須要素のサマリー

必須要素

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

任意要素のサマリー

任意要素

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

要素の詳細

value

public abstract int[] value

文字長を指定します。

重複した値や負の数を指定した場合は除外されます。

戻り値:

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

message

public abstract String message

エラー時のメッセージを指定します。

{key}の書式の場合、プロパティファイルから取得した値を指定できます。

使用可能なメッセージ中の変数は下記の通りです。

• lineNumber : カラムの値に改行が含まれている場合を考慮した実際の行番号です。1から始まります。
• rowNumber : CSVの行番号です。1から始まります。
• columnNumber : CSVの列番号です。1から始まります。
• label : カラムの見出し名です。
• validatedValue : 実際のカラムの値です。
• length : 実際のカラムの値の文字列長です。
• requiredLengths : アノテーションの属性value()の値です。
• joinedRequiredLengths : アノテーションの属性value()を', 'で結合した文字列の値

戻り値:

省略した場合は、適用されたCellProcessorに基づいたメッセージが出力されます。

デフォルト:

"{com.github.mygreen.supercsv.annotation.constraint.CsvLengthExact.message}"

cases

public abstract BuildCase[] cases

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

戻り値:

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

デフォルト:

{}

groups

public abstract Class<?>[] groups

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

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

戻り値:

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

デフォルト:

{}

order

public abstract int order

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

戻り値:

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

デフォルト:

0