ValidationContext (NablarchApi)

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

Type Parameters:

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

Author:

Koichi Asano

See Also:

Message

Constructor Summary

Constructors
Constructor and Description
`ValidationContext(java.lang.String prefix, java.lang.Class<T> targetClass, nablarch.core.validation.FormCreator formCreator, java.util.Map<?> params, java.lang.String validateFor)` `ValidationContext`オブジェクトを生成する。

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`abortIfInvalid()` バリデーションエラーがある場合に、バリデーション結果メッセージを保持した`ApplicationException`を送出する。バリデーションエラーのプロパティがない場合、本メソッドは何もしない。
`void`	`addMessage(java.lang.String messageId, java.lang.Object... params)` メッセージを追加する。
`void`	`addMessages(java.util.List<Message> messages)` メッセージを追加する。
`void`	`addResultMessage(java.lang.String propertyName, java.lang.String messageId, java.lang.Object... params)` バリデーション結果を追加する。
`T`	`createDirtyObject()` フォームオブジェクトを生成する。 `ValidationContext.createObject()`と異なり、生成前にフォームオブジェクトにバリデーションエラーがあるかチェックしない。そのため、バリデーションエラーがあるプロパティもフォームオブジェクトに設定される。ただし、プロパティをフォームオブジェクトのプロパティの型に変換できない場合は設定されない。
`T`	`createObject()` フォームオブジェクトを生成する。
`java.lang.Object`	`getConvertedValue(java.lang.String propertyName)` フォームオブジェクトのプロパティの型に変換したプロパティを取得する。プロパティにバリデーションエラーがある場合も変換した値を返す。変換できない場合、プロパティが見つからない場合は`null`を返す。
`StringResource`	`getMessage(java.lang.String messageId)` メッセージIDに対応するメッセージを取得する。
`java.util.List<Message>`	`getMessages()` バリデーション結果メッセージのリストを取得する。
`java.lang.Object`	`getParameters(java.lang.String propertyName)` プロパティ名に対応するプレフィクス付き文字列の配列を取得する。
`boolean`	`isInvalid(java.lang.String propertyName)` 指定されたプロパティにバリデーションエラーがあるかどうか判定する。バリデーション対象でないプロパティ名が指定された場合は`false`を返す。
`boolean`	`isValid()` バリデーションエラーがないかどうかを取得する。

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

Class ValidationContext<T>

Constructor Summary

Method Summary

Constructor Detail

ValidationContext

Method Detail

addMessage

addMessages

addResultMessage

getMessage

createObject

createDirtyObject

getParameters

getConvertedValue

getMessages

isValid

abortIfInvalid

isInvalid