com.github.mygreen.supercsv.annotation.constraint

注釈型 CsvPattern

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

値が指定した正規表現に一致するかどうか検証するためのアノテーションです。

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

基本的な使い方

• 属性 regex()で、正規表現を指定します。
  Patternで解釈可能な値を指定する必要があります。。
• 属性flags()で、正規表現をコンパイルする際のフラグを列挙型PatternFlagで指定します。
  複数指定すると、ビットOR演算した結果と同じ意味になります。

 @CsvBean
 public class SampleCsv {
     
     @CsvColumn(number=1)
     @CsvPattern(regex="([0-9]{4})/([0-9]{1,2})/([0-9]{1,2})")
     private LocalDate date;
     
     // コンパイル用のフラグを指定する場合
     @CsvColumn(number=2)
     @CsvPattern(regex="^comment(.+)", flags={PatternFlag.CASE_INSENSITIVE})
     private String comment;
     
     
     // getter/setterは省略
 }
 

導入されたバージョン:

2.0

作成者:

T.TSUCHIE

必須要素のサマリー

必須要素

修飾子とタイプ	必須要素と説明
String	regex 正規表現の値。

任意要素のサマリー

任意要素

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

要素の詳細

regex

public abstract String regex

正規表現の値。

戻り値:

Patternで解釈可能な値。

flags

public abstract PatternFlag[] flags

正規表現をコンパイルする際のフラグを指定します。

戻り値:

列挙型PatternFlagで指定します。

デフォルト:

{}

description

public abstract String description

正規表現の説明。

戻り値:

エラー時のメッセージ中の変数として使用可能。

デフォルト:

""

message

public abstract String message

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

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

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

• lineNumber : カラムの値に改行が含まれている場合を考慮した実際の行番号です。1から始まります。
• rowNumber : CSVの行番号です。1から始まります。
• columnNumber : CSVの列番号です。1から始まります。
• label : カラムの見出し名です。
• validatedValue : 実際のカラムの値です。
• regex : アノテーションの属性regex()の値です。
• flags : アノテーションの属性flags()の値をint型に変換した値です。
• description : アノテーションの属性description()の値です。

戻り値:

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

デフォルト:

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

cases

public abstract BuildCase[] cases

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

戻り値:

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

デフォルト:

{}

groups

public abstract Class<?>[] groups

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

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

戻り値:

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

デフォルト:

{}

order

public abstract int order

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

戻り値:

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

デフォルト:

0