com.github.mygreen.supercsv.annotation.constraint

注釈型 CsvNumberMax

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

値が指定した上限値以下かどうか検証するためのアノテーションです。

数値型に指定可能です。

基本的な使い方

• 属性value()で、最大値を指定します。
  値は、クラスタイプや指定した書式に沿った形式で指定する必要があります。
• 属性inclusive()で、値の検証時に属性value()の値を含むかどうか指定します。
  初期値はtrueで、指定した値を含みます。

 @CsvBean
 public class SampleCsv {
     
     @CsvColumn(number=1)
     @CsvNumberMax("1000")
     private long id;
     
     // 値は書式に沿った形式で入力します。
     @CsvColumn(number=2)
     @CsvNumberFormat(pattern="#,##0")
     @CsvNumberMax("1,000,000,000")
     private Integer salary;
     
     // 比較する際には指定した値より小さいかどうかで判定します。
     @CsvColumn(number=3)
     @CsvNumberMax(value="100.0", inclusive=false)
     private Double rate;
     
     // getter/setterは省略
 }
 

導入されたバージョン:

2.0

作成者:

T.TSUCHIE

必須要素のサマリー

必須要素

修飾子とタイプ	必須要素と説明
String	value 上限値となる最大値を指定します。

任意要素のサマリー

任意要素

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

要素の詳細

value

public abstract String value

上限値となる最大値を指定します。

戻り値:

値は、クラスタイプやアノテーションで指定した書式に沿った値を指定する必要があります。

inclusive

public abstract boolean inclusive

値を比較する際に指定した値を含むかどうかを指定します。

戻り値:

trueの場合、値以下かどうかとして比較します。 falseの場合、値より小さいかどうかとして比較します。

デフォルト:

true

message

public abstract String message

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

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

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

• lineNumber : カラムの値に改行が含まれている場合を考慮した実際の行番号です。1から始まります。
• rowNumber : CSVの行番号です。1から始まります。
• columnNumber : CSVの列番号です。1から始まります。
• label : カラムの見出し名です。
• validatedValue : 実際のカラムの値です。
• max : アノテーションの属性value()をフィールドの型に変換した値です。
• inclusive : アノテーションの属性inclusive()の値です。
• printer : カラムの値に対数するフォーマッタです。TextPrinter.print(Object)でvalidatedValue, maxの値を文字列に変換します。

戻り値:

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

デフォルト:

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

cases

public abstract BuildCase[] cases

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

戻り値:

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

デフォルト:

{}

groups

public abstract Class<?>[] groups

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

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

戻り値:

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

デフォルト:

{}

order

public abstract int order

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

戻り値:

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

デフォルト:

0