nablarch.core.validation.domain

クラス DomainValidationHelper

java.lang.Object

nablarch.core.validation.domain.DomainValidationHelper

@Published(tag="architect")
public class DomainValidationHelper
extends java.lang.Object

ドメイン定義によるバリデーションをサポートするヘルパークラス。

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
DomainValidationHelper()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
java.lang.annotation.Annotation	getConvertorAnnotation(java.lang.annotation.Annotation annotation) ドメイン定義に指定されたコンバータのアノテーションを取得する。
static java.lang.annotation.Annotation	getConvertorAnnotation(java.lang.Enum<?> domainEnum) ドメイン定義に指定されたコンバータのアノテーションを取得する。
java.lang.Class<? extends java.lang.annotation.Annotation>	getDomainAnnotation() ドメインを表すアノテーションのクラスを取得する。
protected DomainDefinition	getDomainDefinition(java.lang.annotation.Annotation annotation) アノテーションのvalue属性に指定された値を取得する。
java.util.List<java.lang.annotation.Annotation>	getValidatorAnnotations(java.lang.annotation.Annotation annotation) ドメイン定義に指定されたバリデータのアノテーションを取得する。
static java.util.List<java.lang.annotation.Annotation>	getValidatorAnnotations(java.lang.Enum<?> domainEnum) ドメイン定義に指定されたバリデータのアノテーションを取得する。
boolean	isDomainAnnotation(java.lang.annotation.Annotation annotation) 指定されたアノテーションがドメインを表すアノテーションであるか否かを判定する。
void	setDomainAnnotation(java.lang.String fqcn) PJ毎に作成するドメインを表すアノテーションのFQCNを設定する。

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

DomainValidationHelper

public DomainValidationHelper()

メソッドの詳細

setDomainAnnotation

public void setDomainAnnotation(java.lang.String fqcn)

PJ毎に作成するドメインを表すアノテーションのFQCNを設定する。

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

パラメータ:

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

getDomainAnnotation

public java.lang.Class<? extends java.lang.annotation.Annotation> getDomainAnnotation()

ドメインを表すアノテーションのクラスを取得する。

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

戻り値:

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

isDomainAnnotation

public boolean isDomainAnnotation(java.lang.annotation.Annotation annotation)

指定されたアノテーションがドメインを表すアノテーションであるか否かを判定する。

パラメータ:

annotation - アノテーション

戻り値:

指定されたアノテーションがドメインを表すアノテーションである場合はtrue、それ以外はfalse

getConvertorAnnotation

public java.lang.annotation.Annotation getConvertorAnnotation(java.lang.annotation.Annotation annotation)

ドメイン定義に指定されたコンバータのアノテーションを取得する。

パラメータ:

annotation - ドメインを表すアノテーション

戻り値:

ドメイン定義に指定されたコンバータのアノテーション。コンバータのアノテーションが指定されていない場合はnull

getValidatorAnnotations

public java.util.List<java.lang.annotation.Annotation> getValidatorAnnotations(java.lang.annotation.Annotation annotation)

ドメイン定義に指定されたバリデータのアノテーションを取得する。

パラメータ:

annotation - ドメインを表すアノテーション

戻り値:

ドメイン定義に指定されたバリデータのアノテーション

getDomainDefinition

protected DomainDefinition getDomainDefinition(java.lang.annotation.Annotation annotation)

アノテーションのvalue属性に指定された値を取得する。

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

パラメータ:

annotation - アノテーション

戻り値:

アノテーションのvalue属性に指定された値

getConvertorAnnotation

public static java.lang.annotation.Annotation getConvertorAnnotation(java.lang.Enum<?> domainEnum)

ドメイン定義に指定されたコンバータのアノテーションを取得する。

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

 public Annotation getConvertorAnnotation() {
     return DomainValidationHelper.getConvertorAnnotation(this);
 }
 

パラメータ:

domainEnum - ドメイン定義

戻り値:

ドメイン定義に指定されたコンバータのアノテーション。コンバータのアノテーションが指定されていない場合はnull

getValidatorAnnotations

public static java.util.List<java.lang.annotation.Annotation> getValidatorAnnotations(java.lang.Enum<?> domainEnum)

ドメイン定義に指定されたバリデータのアノテーションを取得する。

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

 public List getValidatorAnnotations() {
     return DomainValidationHelper.getValidatorAnnotations(this);
 }
 

パラメータ:

domainEnum - ドメイン定義

戻り値:

ドメイン定義に指定されたバリデータのアノテーション