Package nablarch.core.validation.domain

Class DomainValidationHelper

java.lang.Object
nablarch.core.validation.domain.DomainValidationHelper
@Published(tag="architect") public class DomainValidationHelper extends Object
ドメイン定義によるバリデーションをサポートするヘルパークラス。

  • Constructor Details

    • DomainValidationHelper

      public DomainValidationHelper()

  • Method Details

    • setDomainAnnotation

      public void setDomainAnnotation(String fqcn)
      PJ毎に作成するドメインを表すアノテーションのFQCNを設定する。

      「ドメイン定義を表すEnum」と「ドメインを表すアノテーション」を1対1でPJ毎に作成し、 本プロパティに「ドメインを表すアノテーション」のFQCNを設定する。

      Parameters:
      fqcn - PJ毎に作成するドメインを表すアノテーションのFQCN

    • getDomainAnnotation

      public Class<? extends Annotation> getDomainAnnotation()
      ドメインを表すアノテーションのクラスを取得する。

      ドメインを表すアノテーションのクラスが設定されていない場合は、IllegalStateExceptionを送出する。

      Returns:
      ドメインを表すアノテーションのクラス

    • isDomainAnnotation

      public boolean isDomainAnnotation(Annotation annotation)
      指定されたアノテーションがドメインを表すアノテーションであるか否かを判定する。
      Parameters:
      annotation - アノテーション
      Returns:
      指定されたアノテーションがドメインを表すアノテーションである場合はtrue、それ以外はfalse

    • getConvertorAnnotation

      public Annotation getConvertorAnnotation(Annotation annotation)
      ドメイン定義に指定されたコンバータのアノテーションを取得する。
      Parameters:
      annotation - ドメインを表すアノテーション
      Returns:
      ドメイン定義に指定されたコンバータのアノテーション。コンバータのアノテーションが指定されていない場合はnull

    • getValidatorAnnotations

      public List<Annotation> getValidatorAnnotations(Annotation annotation)
      ドメイン定義に指定されたバリデータのアノテーションを取得する。
      Parameters:
      annotation - ドメインを表すアノテーション
      Returns:
      ドメイン定義に指定されたバリデータのアノテーション

    • getDomainDefinition

      protected DomainDefinition getDomainDefinition(Annotation annotation)
      アノテーションのvalue属性に指定された値を取得する。

      アノテーションの属性に指定された値が取得できない場合は、 IllegalArgumentExceptionを送出する。

      Parameters:
      annotation - アノテーション
      Returns:
      アノテーションのvalue属性に指定された値

    • getConvertorAnnotation

      public static Annotation getConvertorAnnotation(Enum<?> domainEnum)
      ドメイン定義に指定されたコンバータのアノテーションを取得する。

      DomainDefinition.getConvertorAnnotation()の実装にて本メソッドを使用する。 実装例を以下に示す。 

       public Annotation getConvertorAnnotation() {
     return DomainValidationHelper.getConvertorAnnotation(this);
 }
      Parameters:
      domainEnum - ドメイン定義
      Returns:
      ドメイン定義に指定されたコンバータのアノテーション。コンバータのアノテーションが指定されていない場合はnull

    • getValidatorAnnotations

      public static List<Annotation> getValidatorAnnotations(Enum<?> domainEnum)
      ドメイン定義に指定されたバリデータのアノテーションを取得する。

      DomainDefinition.getValidatorAnnotations()の実装にて本メソッドを使用する。 実装例を以下に示す。 

       public List getValidatorAnnotations() {
     return DomainValidationHelper.getValidatorAnnotations(this);
 }
      Parameters:
      domainEnum - ドメイン定義
      Returns:
      ドメイン定義に指定されたバリデータのアノテーション