ValidationContext (NablarchApi)

java.lang.Object
- nablarch.core.validation.ValidationContext<T>

型パラメータ:

T - バリデーション結果で取得できる型
```
public class ValidationContext<T>
extends Object
```
バリデーション実行中の情報を保持するクラス。

作成者:

Koichi Asano

関連項目:

Message

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

コンストラクタ
コンストラクタと説明
`ValidationContext(String prefix, Class<T> targetClass, nablarch.core.validation.FormCreator formCreator, Map<?> params, String validateFor)` `ValidationContext`オブジェクトを生成する。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`abortIfInvalid()` バリデーションエラーがある場合に、バリデーション結果メッセージを保持した`ApplicationException`を送出する。
`void`	`addMessage(String messageId, Object... params)` メッセージを追加する。
`void`	`addMessages(List<Message> messages)` メッセージを追加する。
`void`	`addResultMessage(String propertyName, String messageId, Object... params)` バリデーション結果を追加する。
`T`	`createDirtyObject()` フォームオブジェクトを生成する。
`T`	`createObject()` フォームオブジェクトを生成する。
`Object`	`getConvertedValue(String propertyName)` フォームオブジェクトのプロパティの型に変換したプロパティを取得する。
`StringResource`	`getMessage(String messageId)` メッセージIDに対応するメッセージを取得する。
`List<Message>`	`getMessages()` バリデーション結果メッセージのリストを取得する。
`Object`	`getParameters(String propertyName)` プロパティ名に対応するプレフィクス付き文字列の配列を取得する。
`boolean`	`isInvalid(String propertyName)` 指定されたプロパティにバリデーションエラーがあるかどうか判定する。
`boolean`	`isValid()` バリデーションエラーがないかどうかを取得する。

- コンストラクタの詳細
  - ValidationContext
```
@Published(tag="architect")
public ValidationContext(String prefix,
                                                     Class<T> targetClass,
                                                     nablarch.core.validation.FormCreator formCreator,
                                                     Map<?> params,
                                                     String validateFor)
```
    ValidationContextオブジェクトを生成する。
    
    パラメータ:
    
    prefix - バリデーション対象のプレフィクス
    
    targetClass - バリデーション対象のクラス
    
    formCreator - FormCreator
    
    params - パラメータのMap
    
    validateFor - バリデーション対象メソッド
- メソッドの詳細
  - addMessage
```
@Published
public void addMessage(String messageId,
                                  Object... params)
```
    メッセージを追加する。
    
    パラメータ:
    
    messageId - メッセージID
    
    params - メッセージに埋め込む値
  - addMessages
```
@Published(tag="architect")
public void addMessages(List<Message> messages)
```
    メッセージを追加する。
    
    パラメータ:
    
    messages - メッセージのリスト
  - addResultMessage
```
@Published(tag="architect")
public void addResultMessage(String propertyName,
                                                         String messageId,
                                                         Object... params)
```
    バリデーション結果を追加する。
    
    パラメータ:
    
    propertyName - プロパティ名
    
    messageId - バリデーション結果メッセージのメッセージID
    
    params - メッセージのオプションパラメータ
    
    例外:
    
    IllegalArgumentException - プロパティ名がnullまたは空文字だった場合
  - getMessage
```
@Published(tag="architect")
public StringResource getMessage(String messageId)
```
    メッセージIDに対応するメッセージを取得する。
    
    パラメータ:
    
    messageId - メッセージID
    
    戻り値:
    
    メッセージIDに対応するメッセージ
  - createObject
```
@Published
public T createObject()
```
    フォームオブジェクトを生成する。
    
    戻り値:
    
    フォームオブジェクト
    
    例外:
    
    IllegalStateException - フォームオブジェクトにバリデーションエラーのプロパティがある場合
  - createDirtyObject
```
@Published(tag="architect")
public T createDirtyObject()
```
    フォームオブジェクトを生成する。
    ValidationContext.createObject()と異なり、生成前にフォームオブジェクトにバリデーションエラーがあるかチェックしない。
    そのため、バリデーションエラーがあるプロパティもフォームオブジェクトに設定される。
    ただし、プロパティをフォームオブジェクトのプロパティの型に変換できない場合は設定されない。
    
    戻り値:
    
    フォームオブジェクト
  - getParameters
```
@Published(tag="architect")
public Object getParameters(String propertyName)
```
    プロパティ名に対応するプレフィクス付き文字列の配列を取得する。
    
    パラメータ:
    
    propertyName - プロパティ名
    
    戻り値:
    
    プロパティ名に対応するプレフィクス付き文字列の配列
  - getConvertedValue
```
@Published
public Object getConvertedValue(String propertyName)
```
    フォームオブジェクトのプロパティの型に変換したプロパティを取得する。
    プロパティにバリデーションエラーがある場合も変換した値を返す。変換できない場合、プロパティが見つからない場合はnullを返す。
    
    パラメータ:
    
    propertyName - 取得するプロパティ名
    
    戻り値:
    
    変換したプロパティの値
  - getMessages
```
@Published
public List<Message> getMessages()
```
    バリデーション結果メッセージのリストを取得する。
    
    戻り値:
    
    バリデーション結果メッセージのリスト
  - isValid
```
@Published
public boolean isValid()
```
    バリデーションエラーがないかどうかを取得する。
    
    戻り値:
    
    バリデーションエラーがない場合はtrue
  - abortIfInvalid
```
@Published
public void abortIfInvalid()
                               throws ApplicationException
```
    バリデーションエラーがある場合に、バリデーション結果メッセージを保持したApplicationExceptionを送出する。
    バリデーションエラーのプロパティがない場合、本メソッドは何もしない。
    
    例外:
    
    ApplicationException - バリデーションエラーのプロパティがある場合
  - isInvalid
```
@Published
public boolean isInvalid(String propertyName)
```
    指定されたプロパティにバリデーションエラーがあるかどうか判定する。
    バリデーション対象でないプロパティ名が指定された場合はfalseを返す。
    
    パラメータ:
    
    propertyName - プロパティ名
    
    戻り値:
    
    指定されたプロパティにバリデーションエラーがある場合はtrue

クラス ValidationContext<T>

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

メソッドのサマリー

コンストラクタの詳細

ValidationContext

メソッドの詳細

addMessage

addMessages

addResultMessage

getMessage

createObject

createDirtyObject

getParameters

getConvertedValue

getMessages

isValid

abortIfInvalid

isInvalid