com.github.mygreen.supercsv.annotation.constraint

注釈型 CsvUnique

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

値が他の行と異なるか検証するためのアノテーションです。

全てのクラスタイプに指定可能です。

基本的な使い方

値を比較する際には、各要素の値のequals()メソッドを用いて判定します。

比較する際に、オブジェクト値をキャッシュするため、レコード数やオブジェクトのサイズによってはメモリをより多く消費します。 そのような場合は、ハッシュ値で検証するCsvUniqueHashCodeを利用してください。

 @CsvBean
 public class SampleCsv {
     
     @CsvColumn(number=1)
     @CsvUnique
     private long id;
     
     // getter/setterは省略
 }
 

導入されたバージョン:

2.0

作成者:

T.TSUCHIE

任意要素のサマリー

任意要素

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

要素の詳細

message

public abstract String message

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

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

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

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

戻り値:

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

デフォルト:

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

cases

public abstract BuildCase[] cases

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

戻り値:

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

デフォルト:

{}

groups

public abstract Class<?>[] groups

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

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

戻り値:

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

デフォルト:

{}

order

public abstract int order

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

戻り値:

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

デフォルト:

0