DomainValidationHelper (NablarchApi)

java.lang.Object
- nablarch.core.validation.domain.DomainValidationHelper

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

Author:

Kiyohito Itoh

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.annotation.Annotation`	`getConvertorAnnotation(java.lang.annotation.Annotation annotation)` ドメイン定義に指定されたコンバータのアノテーションを取得する。
`static java.lang.annotation.Annotation`	`getConvertorAnnotation(java.lang.Enum<?> domainEnum)` ドメイン定義に指定されたコンバータのアノテーションを取得する。 `DomainDefinition.getConvertorAnnotation()`の実装にて本メソッドを使用する。実装例を以下に示す。
`java.lang.Class<?>`	`getDomainAnnotation()` ドメインを表すアノテーションのクラスを取得する。ドメインを表すアノテーションのクラスが設定されていない場合は、`IllegalStateException`を送出する。
`protected DomainDefinition`	`getDomainDefinition(java.lang.annotation.Annotation annotation)` アノテーションのvalue属性に指定された値を取得する。アノテーションの属性に指定された値が取得できない場合は、 `IllegalArgumentException`を送出する。
`java.util.List`	`getValidatorAnnotations(java.lang.annotation.Annotation annotation)` ドメイン定義に指定されたバリデータのアノテーションを取得する。
`static java.util.List`	`getValidatorAnnotations(java.lang.Enum<?> domainEnum)` ドメイン定義に指定されたバリデータのアノテーションを取得する。 `DomainDefinition.getValidatorAnnotations()`の実装にて本メソッドを使用する。実装例を以下に示す。
`boolean`	`isDomainAnnotation(java.lang.annotation.Annotation annotation)` 指定されたアノテーションがドメインを表すアノテーションであるか否かを判定する。
`void`	`setDomainAnnotation(java.lang.String fqcn)` PJ毎に作成するドメインを表すアノテーションのFQCNを設定する。「ドメイン定義を表すEnum」と「ドメインを表すアノテーション」を1対1でPJ毎に作成し、本プロパティに「ドメインを表すアノテーション」のFQCNを設定する。

- Method Detail
  - setDomainAnnotation
```
public void setDomainAnnotation(java.lang.String fqcn)
```
    PJ毎に作成するドメインを表すアノテーションのFQCNを設定する。
    「ドメイン定義を表すEnum」と「ドメインを表すアノテーション」を1対1でPJ毎に作成し、本プロパティに「ドメインを表すアノテーション」のFQCNを設定する。
    
    Parameters:
    
    fqcn - PJ毎に作成するドメインを表すアノテーションのFQCN
  - getDomainAnnotation
```
public java.lang.Class<?> getDomainAnnotation()
```
    ドメインを表すアノテーションのクラスを取得する。
    ドメインを表すアノテーションのクラスが設定されていない場合は、IllegalStateExceptionを送出する。
    
    Returns:
    
    ドメインを表すアノテーションのクラス
  - isDomainAnnotation
```
public boolean isDomainAnnotation(java.lang.annotation.Annotation annotation)
```
    指定されたアノテーションがドメインを表すアノテーションであるか否かを判定する。
    
    Parameters:
    
    annotation - アノテーション
    
    Returns:
    
    指定されたアノテーションがドメインを表すアノテーションである場合はtrue、それ以外はfalse
  - getConvertorAnnotation
```
public java.lang.annotation.Annotation getConvertorAnnotation(java.lang.annotation.Annotation annotation)
```
    ドメイン定義に指定されたコンバータのアノテーションを取得する。
    
    Parameters:
    
    annotation - ドメインを表すアノテーション
    
    Returns:
    
    ドメイン定義に指定されたコンバータのアノテーション。コンバータのアノテーションが指定されていない場合はnull
  - getValidatorAnnotations
```
public java.util.List getValidatorAnnotations(java.lang.annotation.Annotation annotation)
```
    ドメイン定義に指定されたバリデータのアノテーションを取得する。
    
    Parameters:
    
    annotation - ドメインを表すアノテーション
    
    Returns:
    
    ドメイン定義に指定されたバリデータのアノテーション
  - getDomainDefinition
```
protected DomainDefinition getDomainDefinition(java.lang.annotation.Annotation annotation)
```
    アノテーションのvalue属性に指定された値を取得する。
    アノテーションの属性に指定された値が取得できない場合は、 IllegalArgumentExceptionを送出する。
    
    Parameters:
    
    annotation - アノテーション
    
    Returns:
    
    アノテーションのvalue属性に指定された値
  - getConvertorAnnotation
```
public static java.lang.annotation.Annotation getConvertorAnnotation(java.lang.Enum<?> domainEnum)
```
    ドメイン定義に指定されたコンバータのアノテーションを取得する。
    DomainDefinition.getConvertorAnnotation()の実装にて本メソッドを使用する。実装例を以下に示す。
```
 public Annotation getConvertorAnnotation() {
     return DomainValidationHelper.getConvertorAnnotation(this);
 }
 
```
    Parameters:
    
    domainEnum - ドメイン定義
    
    Returns:
    
    ドメイン定義に指定されたコンバータのアノテーション。コンバータのアノテーションが指定されていない場合はnull
  - getValidatorAnnotations
```
public static java.util.List getValidatorAnnotations(java.lang.Enum<?> domainEnum)
```
    ドメイン定義に指定されたバリデータのアノテーションを取得する。
    DomainDefinition.getValidatorAnnotations()の実装にて本メソッドを使用する。実装例を以下に示す。
```
 public List getValidatorAnnotations() {
     return DomainValidationHelper.getValidatorAnnotations(this);
 }
 
```
    Parameters:
    
    domainEnum - ドメイン定義
    
    Returns:
    
    ドメイン定義に指定されたバリデータのアノテーション

Class DomainValidationHelper

Method Summary

Method Detail

setDomainAnnotation

getDomainAnnotation

isDomainAnnotation

getConvertorAnnotation

getValidatorAnnotations

getDomainDefinition

getConvertorAnnotation

getValidatorAnnotations