インターフェース Errors
- すべての既知のサブインターフェース:
BindingResult
- すべての既知の実装クラス:
AbstractBindingResult
、AbstractErrors
、AbstractPropertyBindingResult
、BeanPropertyBindingResult
、BindException
、DirectFieldBindingResult
、EscapedErrors
、MapBindingResult
、MethodArgumentNotValidException
、WebExchangeBindException
フィールド名は、ターゲットオブジェクトのプロパティ(例: 顧客オブジェクトにバインドするときの「名前」)、またはサブオブジェクトの場合はネストされたフィールド(例: "address.street" )にすることができます。setNestedPath(String)
を介したサブツリーナビゲーションをサポートします。たとえば、AddressValidator
は「住所」を検証しますが、これが顧客のサブオブジェクトであることを認識していません。
メモ: Errors
オブジェクトはシングルスレッドです。
- 作成者:
- Rod Johnson, Juergen Hoeller
- 関連事項:
フィールドサマリー
フィールド修飾子と型フィールド説明static final StringSE
ネストされたパス(たとえば、"customer.name" または "customer.address.street" )内のパス要素間の区切り文字。メソッドのサマリー
修飾子と型メソッド説明void
addAllErrors
(Errors errors) 指定されたErrors
インスタンスからのすべてのエラーをこのErrors
インスタンスに追加します。グローバルエラーとフィールドエラーの両方のすべてのエラーを取得します。int
エラーの総数を返します。フィールドに関連付けられている最初のエラーがあれば、それを取得します。getFieldError
(StringSE field) 指定されたフィールドに関連付けられている最初のエラーがあれば、それを取得します。int
フィールドに関連付けられているエラーの数を返します。int
getFieldErrorCount
(StringSE field) 指定されたフィールドに関連付けられているエラーの数を返します。フィールドに関連付けられているすべてのエラーを取得します。getFieldErrors
(StringSE field) 指定されたフィールドに関連するすべてのエラーを取得します。ClassSE<?>
getFieldType
(StringSE field) 指定されたフィールドの型を返します。getFieldValue
(StringSE field) 指定されたフィールドの現在の値、現在の Bean プロパティ値、最後のバインディングからの拒否された更新を返します。もしあれば、 最初のグローバルエラーを取得します。int
グローバルエラーの数を返します。すべてのグローバルエラーを取得します。このErrors
オブジェクトの現在のネストされたパスを返します。バインドされたルートオブジェクトの名前を返します。boolean
エラーがあった場合に戻ります。boolean
フィールドエラーはありますか?boolean
hasFieldErrors
(StringSE field) 特定のフィールドに関連するエラーはありますか?boolean
グローバルエラーはありますか?void
ネストされたパススタックから以前のネストされたパスをポップします。void
pushNestedPath
(StringSE subPath) 指定されたサブパスをネストされたパススタックにプッシュします。void
指定されたエラーの説明を使用して、ターゲットオブジェクト全体のグローバルエラーを登録します。void
指定されたエラーの説明を使用して、ターゲットオブジェクト全体のグローバルエラーを登録します。void
指定されたエラーの説明を使用して、ターゲットオブジェクト全体のグローバルエラーを登録します。void
rejectValue
(StringSE field, StringSE errorCode) 指定されたエラーの説明を使用して、現在のオブジェクトの指定されたフィールドのフィールドエラーを登録します(存在する場合、現在のネストされたパスを考慮します)。void
rejectValue
(StringSE field, StringSE errorCode, ObjectSE[] errorArgs, StringSE defaultMessage) 指定されたエラーの説明を使用して、現在のオブジェクトの指定されたフィールドのフィールドエラーを登録します(存在する場合、現在のネストされたパスを考慮します)。void
rejectValue
(StringSE field, StringSE errorCode, StringSE defaultMessage) 指定されたエラーの説明を使用して、現在のオブジェクトの指定されたフィールドのフィールドエラーを登録します(存在する場合、現在のネストされたパスを考慮します)。void
setNestedPath
(StringSE nestedPath) 標準バリデーターがサブツリーを検証できるように、コンテキストの変更を許可します。
フィールドの詳細
NESTED_PATH_SEPARATOR
ネストされたパス(たとえば、"customer.name" または "customer.address.street" )内のパス要素間の区切り文字。"" = Bean パッケージの
nested property separator
と同じ。- 関連事項:
メソッドの詳細
getObjectName
StringSE getObjectName()バインドされたルートオブジェクトの名前を返します。setNestedPath
標準バリデーターがサブツリーを検証できるように、コンテキストの変更を許可します。呼び出しを拒否すると、指定されたパスがフィールド名の前に追加されます。例: 住所検証ツールは、顧客オブジェクトのサブオブジェクト「住所」を検証できます。
- パラメーター:
nestedPath
- このオブジェクト内のネストされたパス。「アドレス」(デフォルトは ""、null
も使用可能)。「アドレス」と「アドレス」の両方で終わることができます。有効です。
getNestedPath
StringSE getNestedPath()このErrors
オブジェクトの現在のネストされたパスを返します。連結されたパスを簡単に構築するために、ドット付きのネストされたパス、つまり「アドレス」を返します。デフォルトは空の文字列です。
pushNestedPath
指定されたサブパスをネストされたパススタックにプッシュします。popNestedPath()
呼び出しは、対応するpushNestedPath(String)
呼び出しの前に元のネストされたパスをリセットします。ネストパススタックを使用すると、一時パスホルダーを気にすることなく、サブオブジェクトの一時ネストパスを設定できます。
次に例を示します: 現在のパス "spouse。"、pushNestedPath("child" )→ 結果パス "spouse.child。"; popNestedPath()→ " 配偶者。" また。
- パラメーター:
subPath
- ネストされたパススタックにプッシュするサブパス- 関連事項:
popNestedPath
ネストされたパススタックから以前のネストされたパスをポップします。- 例外:
IllegalStateExceptionSE
- スタックに元のネストされたパスがない場合- 関連事項:
reject
指定されたエラーの説明を使用して、ターゲットオブジェクト全体のグローバルエラーを登録します。- パラメーター:
errorCode
- エラーコード、メッセージキーとして解釈可能
reject
指定されたエラーの説明を使用して、ターゲットオブジェクト全体のグローバルエラーを登録します。- パラメーター:
errorCode
- エラーコード、メッセージキーとして解釈可能defaultMessage
- フォールバックのデフォルトメッセージ
reject
指定されたエラーの説明を使用して、ターゲットオブジェクト全体のグローバルエラーを登録します。- パラメーター:
errorCode
- エラーコード、メッセージキーとして解釈可能errorArgs
- エラー引数、MessageFormat を介した引数バインディング用 (null
にすることができます)defaultMessage
- フォールバックのデフォルトメッセージ
rejectValue
指定されたエラーの説明を使用して、現在のオブジェクトの指定されたフィールドのフィールドエラーを登録します(存在する場合、現在のネストされたパスを考慮します)。フィールド名は
null
または空の文字列で、フィールドではなく現在のオブジェクト自体を示します。これにより、ネストされたオブジェクトグラフ内で対応するフィールドエラーが発生するか、現在のオブジェクトが最上位オブジェクトである場合にグローバルエラーが発生する可能性があります。- パラメーター:
field
- フィールド名 (null
または空の文字列です)errorCode
- エラーコード、メッセージキーとして解釈可能- 関連事項:
rejectValue
指定されたエラーの説明を使用して、現在のオブジェクトの指定されたフィールドのフィールドエラーを登録します(存在する場合、現在のネストされたパスを考慮します)。フィールド名は
null
または空の文字列で、フィールドではなく現在のオブジェクト自体を示します。これにより、ネストされたオブジェクトグラフ内で対応するフィールドエラーが発生するか、現在のオブジェクトが最上位オブジェクトである場合にグローバルエラーが発生する可能性があります。- パラメーター:
field
- フィールド名 (null
または空の文字列です)errorCode
- エラーコード、メッセージキーとして解釈可能defaultMessage
- フォールバックのデフォルトメッセージ- 関連事項:
rejectValue
void rejectValue(@Nullable StringSE field, StringSE errorCode, @Nullable ObjectSE[] errorArgs, @Nullable StringSE defaultMessage) 指定されたエラーの説明を使用して、現在のオブジェクトの指定されたフィールドのフィールドエラーを登録します(存在する場合、現在のネストされたパスを考慮します)。フィールド名は
null
または空の文字列で、フィールドではなく現在のオブジェクト自体を示します。これにより、ネストされたオブジェクトグラフ内で対応するフィールドエラーが発生するか、現在のオブジェクトが最上位オブジェクトである場合にグローバルエラーが発生する可能性があります。- パラメーター:
field
- フィールド名 (null
または空の文字列です)errorCode
- エラーコード、メッセージキーとして解釈可能errorArgs
- エラー引数、MessageFormat を介した引数バインディング用 (null
にすることができます)defaultMessage
- フォールバックのデフォルトメッセージ- 関連事項:
addAllErrors
指定されたErrors
インスタンスからのすべてのエラーをこのErrors
インスタンスに追加します。これは、
Errors
インスタンスを別のErrors
インスタンスにマージするために繰り返されるreject(..)
呼び出しを避けるための便利なメソッドです。渡された
Errors
インスタンスは同じターゲットオブジェクトを参照するか、少なくともこのErrors
インスタンスのターゲットオブジェクトに適用される互換性のあるエラーを含むことに注意してください。- パラメーター:
errors
- マージするErrors
インスタンス
hasErrors
boolean hasErrors()エラーがあった場合に戻ります。getErrorCount
int getErrorCount()エラーの総数を返します。getAllErrors
ListSE<ObjectError> getAllErrors()グローバルエラーとフィールドエラーの両方のすべてのエラーを取得します。- 戻り値:
ObjectError
インスタンスのリスト
hasGlobalErrors
boolean hasGlobalErrors()グローバルエラーはありますか?- 戻り値:
- グローバルエラーがある場合は
true
- 関連事項:
getGlobalErrorCount
int getGlobalErrorCount()グローバルエラーの数を返します。- 戻り値:
- グローバルエラーの数
- 関連事項:
getGlobalErrors
ListSE<ObjectError> getGlobalErrors()すべてのグローバルエラーを取得します。- 戻り値:
ObjectError
インスタンスのリスト
getGlobalError
もしあれば、 最初のグローバルエラーを取得します。- 戻り値:
- グローバルエラー、または
null
hasFieldErrors
boolean hasFieldErrors()フィールドエラーはありますか?- 戻り値:
- フィールドに関連するエラーがある場合は
true
- 関連事項:
getFieldErrorCount
int getFieldErrorCount()フィールドに関連付けられているエラーの数を返します。- 戻り値:
- フィールドに関連付けられたエラーの数
- 関連事項:
getFieldErrors
ListSE<FieldError> getFieldErrors()フィールドに関連付けられているすべてのエラーを取得します。- 戻り値:
FieldError
インスタンスのリスト
getFieldError
フィールドに関連付けられている最初のエラーがあれば、それを取得します。- 戻り値:
- フィールド固有のエラー、または
null
hasFieldErrors
特定のフィールドに関連するエラーはありますか?- パラメーター:
field
- フィールド名- 戻り値:
- 指定されたフィールドに関連するエラーがある場合は、
true
getFieldErrorCount
指定されたフィールドに関連付けられているエラーの数を返します。- パラメーター:
field
- フィールド名- 戻り値:
- 指定されたフィールドに関連付けられたエラーの数
getFieldErrors
指定されたフィールドに関連するすべてのエラーを取得します。実装では、"name" などの完全なフィールド名だけでなく、"na *" や "address.*" などのパターン一致もサポートする必要があります。
- パラメーター:
field
- フィールド名- 戻り値:
FieldError
インスタンスのリスト
getFieldError
指定されたフィールドに関連付けられている最初のエラーがあれば、それを取得します。- パラメーター:
field
- フィールド名- 戻り値:
- フィールド固有のエラー、または
null
getFieldValue
指定されたフィールドの現在の値、現在の Bean プロパティ値、最後のバインディングからの拒否された更新を返します。型の不一致があった場合でも、ユーザー指定のフィールド値に簡単にアクセスできます。
- パラメーター:
field
- フィールド名- 戻り値:
- 指定されたフィールドの現在の値
getFieldType
指定されたフィールドの型を返します。実装は、フィールド値が
null
の場合でも、たとえば関連する記述子から型を判別できる必要があります。- パラメーター:
field
- フィールド名- 戻り値:
- フィールドの型、または判別できない場合は
null