com.github.mygreen.supercsv.annotation.constraint

注釈型 CsvConstraint

@Target(value=ANNOTATION_TYPE)
 @Retention(value=RUNTIME)
 @Documented
public @interface CsvConstraint

制約のアノテーションを表現するためのメタアノテーションです。

制約のアノテーションには必ず付与します。

基本的な使い方

• @Targetとして、ElementType.FIELDとElementType.ANNOTATION_TYPEの2つを指定します。
  アノテーションを合成する際にはアノテーションにも付与するため、ElementType.ANNOTATION_TYPEを追加しておきます。
• 繰り返しのアノテーションとして利用できるよう @Repeatableを付与します。
  繰り返しのアノテーションを格納する内部アノテーションとして、Listを定義します。
• 検証用のアノテーションであることを示すためのメタアノテーション @CsvContraintを指定します。
  属性value()で、ConstraintProcessorFactoryの実装クラスを指定します。
• 共通の属性として、cases, groups, orderを定義します。
  省略した場合は、それぞれのデフォルト値が適用されます。
• 必要であれば、固有の属性を定義します。

 // 独自の値の検証用のアノテーション
 @Target({ElementType.FIELD, ElementType.ANNOTATION_TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
 @Repeatable(CsvCustomConstraint.List.class)
 @CsvConstraint(CustomConstratinFactory.class)  // ファクトリクラスを指定
 public @interface CsvCustomConstraint {
     
     // 固有の属性 - 必要であれば定義します。
     String text();
     
     // 共通の属性 - ケース
     BuildCase[] cases() default {};
    
     // 共通の属性 - グループ
     Class<?>[] groups() default {};
     
     // 共通の属性 - 並び順
     int order() default 0;
     
     // 繰り返しのアノテーションの格納用アノテーションの定義
     @Target({ElementType.FIELD, ElementType.ANNOTATION_TYPE})
     @Retention(RetentionPolicy.RUNTIME)
     @Documented
     @interface List {
     
         CsvCustomConstraint[] value();
     }
 }
 

導入されたバージョン:

2.0

作成者:

T.TSUCHIE

必須要素のサマリー

必須要素

修飾子とタイプ	必須要素と説明
Class<? extends ConstraintProcessorFactory<?>>[]	value アノテーションに対応したCellProcessorを作成するファクトリクラスを指定します。

要素の詳細

value

public abstract Class<? extends ConstraintProcessorFactory<?>>[] value

アノテーションに対応したCellProcessorを作成するファクトリクラスを指定します。

省略した場合、AbstractProcessorBuilder.registerForConstraint(Class, ConstraintProcessorFactory)で手動で登録する必要があります。

戻り値:

ConstraintProcessorFactoryを実装したクラスを指定します。