クラス BindException
- 実装されているすべてのインターフェース:
SerializableSE、BindingResult、Errors
- 既知の直属サブクラス
MethodArgumentNotValidException
BindingResult インターフェース(およびそのスーパーインターフェース Errors)を実装して、バインディングエラーの直接分析を可能にします。Spring 2.0 以降、これは特殊目的クラスです。通常、アプリケーションコードは BindingResult インターフェース、または DataBinder で動作し、次に DataBinder.getBindingResult() を介して BindingResult を公開します。
- 作成者:
- Rod Johnson, Juergen Hoeller, Rob Harrop
- 関連事項:
フィールドのサマリー
インターフェース org.springframework.validation.BindingResult から継承されたフィールド
MODEL_KEY_PREFIXインターフェース org.springframework.validation.Errors から継承されたフィールド
NESTED_PATH_SEPARATORコンストラクターの概要
コンストラクターコンストラクター説明BindException(ObjectSE target, StringSE objectName) ターゲット Bean の新しい BindException インスタンスを作成します。BindException(BindingResult bindingResult) BindingResult の新しい BindException インスタンスを作成します。メソッドのサマリー
修飾子と型メソッド説明voidaddAllErrors(Errors errors) 指定されたErrorsインスタンスからのすべてのエラーをこのErrorsインスタンスに追加します。voidaddError(ObjectError error) カスタムObjectErrorまたはFieldErrorをエラーリストに追加します。booleanfindEditor(StringSE field, ClassSE valueType) 指定された型とプロパティのカスタムプロパティエディターを見つけます。グローバルエラーとフィールドエラーの両方のすべてのエラーを取得します。final BindingResultこの BindException がラップする BindingResult を返します。intエラーの総数を返します。フィールドに関連付けられている最初のエラーがあれば、それを取得します。getFieldError(StringSE field) 指定されたフィールドに関連付けられている最初のエラーがあれば、それを取得します。intフィールドに関連付けられているエラーの数を返します。intgetFieldErrorCount(StringSE field) 指定されたフィールドに関連付けられているエラーの数を返します。フィールドに関連付けられているすべてのエラーを取得します。getFieldErrors(StringSE field) 指定されたフィールドに関連するすべてのエラーを取得します。ClassSE<?>getFieldType(StringSE field) 指定されたフィールドの型を返します。getFieldValue(StringSE field) 指定されたフィールドの現在の値、現在の Bean プロパティ値、最後のバインディングからの拒否された更新を返します。もしあれば、 最初のグローバルエラーを取得します。intグローバルエラーの数を返します。すべてのグローバルエラーを取得します。このオブジェクトに保持されているエラーに関する診断情報を返します。getModel()取得した状態のモデルマップを返し、BindingResult インスタンスを 'MODEL_KEY_PREFIX+ objectName' として公開し、オブジェクト自体を 'objectName' として公開します。このErrorsオブジェクトの現在のネストされたパスを返します。バインドされたルートオブジェクトの名前を返します。基になる PropertyEditorRegistry を返します。getRawFieldValue(StringSE field) 指定されたフィールドの未加工フィールド値を抽出します。StringSE[]バインドプロセス中に抑制されたフィールドのリストを返します。具体的なバインディング戦略に応じて、Bean、パブリックフィールドを持つオブジェクト、マップなどのラップされたターゲットオブジェクトを返します。booleanエラーがあった場合に戻ります。booleanフィールドエラーはありますか?booleanhasFieldErrors(StringSE field) 特定のフィールドに関連するエラーはありますか?booleanグローバルエラーはありますか?inthashCode()voidネストされたパススタックから以前のネストされたパスをポップします。voidpushNestedPath(StringSE subPath) 指定されたサブパスをネストされたパススタックにプッシュします。voidrecordFieldValue(StringSE field, ClassSE<?> type, ObjectSE value) 指定されたフィールドに指定された値を記録します。voidrecordSuppressedField(StringSE field) 指定された許可されていないフィールドを非表示としてマークします。void指定されたエラーの説明を使用して、ターゲットオブジェクト全体のグローバルエラーを登録します。void指定されたエラーの説明を使用して、ターゲットオブジェクト全体のグローバルエラーを登録します。void指定されたエラーの説明を使用して、ターゲットオブジェクト全体のグローバルエラーを登録します。voidrejectValue(StringSE field, StringSE errorCode) 指定されたエラーの説明を使用して、現在のオブジェクトの指定されたフィールドのフィールドエラーを登録します(存在する場合、現在のネストされたパスを考慮します)。voidrejectValue(StringSE field, StringSE errorCode, ObjectSE[] errorArgs, StringSE defaultMessage) 指定されたエラーの説明を使用して、現在のオブジェクトの指定されたフィールドのフィールドエラーを登録します(存在する場合、現在のネストされたパスを考慮します)。voidrejectValue(StringSE field, StringSE errorCode, StringSE defaultMessage) 指定されたエラーの説明を使用して、現在のオブジェクトの指定されたフィールドのフィールドエラーを登録します(存在する場合、現在のネストされたパスを考慮します)。StringSE[]resolveMessageCodes(StringSE errorCode) 指定されたエラーコードをメッセージコードに解決します。StringSE[]resolveMessageCodes(StringSE errorCode, StringSE field) 指定されたエラーコードを、指定されたフィールドのメッセージコードに解決します。voidsetNestedPath(StringSE nestedPath) 標準バリデーターがサブツリーを検証できるように、コンテキストの変更を許可します。クラス java.lang.ThrowableSE から継承されたメソッド
addSuppressedSE, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCauseSE, printStackTrace, printStackTraceSE, printStackTraceSE, setStackTraceSE, toString
コンストラクターの詳細
BindException
BindingResult の新しい BindException インスタンスを作成します。- パラメーター:
bindingResult- ラップする BindingResult インスタンス
BindException
ターゲット Bean の新しい BindException インスタンスを作成します。- パラメーター:
target- バインドするターゲット BeanobjectName- ターゲットオブジェクトの名前- 関連事項:
メソッドの詳細
getBindingResult
この BindException がラップする BindingResult を返します。getObjectName
インターフェースからコピーされた説明:Errorsバインドされたルートオブジェクトの名前を返します。- 次で指定:
- インターフェース
ErrorsのgetObjectName
setNestedPath
インターフェースからコピーされた説明:Errors標準バリデーターがサブツリーを検証できるように、コンテキストの変更を許可します。呼び出しを拒否すると、指定されたパスがフィールド名の前に追加されます。例: 住所検証ツールは、顧客オブジェクトのサブオブジェクト「住所」を検証できます。
- 次で指定:
- インターフェース
ErrorsのsetNestedPath - パラメーター:
nestedPath- このオブジェクト内のネストされたパス。「アドレス」(デフォルトは ""、nullも使用可能)。「アドレス」と「アドレス」の両方で終わることができます。有効です。
getNestedPath
インターフェースからコピーされた説明:ErrorsこのErrorsオブジェクトの現在のネストされたパスを返します。連結されたパスを簡単に構築するために、ドット付きのネストされたパス、つまり「アドレス」を返します。デフォルトは空の文字列です。
- 次で指定:
- インターフェース
ErrorsのgetNestedPath
pushNestedPath
インターフェースからコピーされた説明:Errors指定されたサブパスをネストされたパススタックにプッシュします。Errors.popNestedPath()呼び出しは、対応するpushNestedPath(String)呼び出しの前に元のネストされたパスをリセットします。ネストパススタックを使用すると、一時パスホルダーを気にすることなく、サブオブジェクトの一時ネストパスを設定できます。
次に例を示します: 現在のパスは "spouse."、pushNestedPath("child" ) → 結果パスは "spouse.child."、popNestedPath() → 再び "spouse."
- 次で指定:
- インターフェース
ErrorsのpushNestedPath - パラメーター:
subPath- ネストされたパススタックにプッシュするサブパス- 関連事項:
popNestedPath
インターフェースからコピーされた説明:Errorsネストされたパススタックから以前のネストされたパスをポップします。- 次で指定:
- インターフェース
ErrorsのpopNestedPath - 例外:
IllegalStateExceptionSE- スタックに元のネストされたパスがない場合- 関連事項:
reject
インターフェースからコピーされた説明:Errors指定されたエラーの説明を使用して、ターゲットオブジェクト全体のグローバルエラーを登録します。reject
インターフェースからコピーされた説明:Errors指定されたエラーの説明を使用して、ターゲットオブジェクト全体のグローバルエラーを登録します。reject
public void reject(StringSE errorCode, @Nullable ObjectSE[] errorArgs, @Nullable StringSE defaultMessage) インターフェースからコピーされた説明:Errors指定されたエラーの説明を使用して、ターゲットオブジェクト全体のグローバルエラーを登録します。rejectValue
インターフェースからコピーされた説明:Errors指定されたエラーの説明を使用して、現在のオブジェクトの指定されたフィールドのフィールドエラーを登録します(存在する場合、現在のネストされたパスを考慮します)。フィールド名は
nullまたは空の文字列で、フィールドではなく現在のオブジェクト自体を示します。これにより、ネストされたオブジェクトグラフ内で対応するフィールドエラーが発生するか、現在のオブジェクトが最上位オブジェクトである場合にグローバルエラーが発生する可能性があります。- 次で指定:
- インターフェース
ErrorsのrejectValue - パラメーター:
field- フィールド名 (nullまたは空の文字列です)errorCode- エラーコード、メッセージキーとして解釈可能- 関連事項:
rejectValue
インターフェースからコピーされた説明:Errors指定されたエラーの説明を使用して、現在のオブジェクトの指定されたフィールドのフィールドエラーを登録します(存在する場合、現在のネストされたパスを考慮します)。フィールド名は
nullまたは空の文字列で、フィールドではなく現在のオブジェクト自体を示します。これにより、ネストされたオブジェクトグラフ内で対応するフィールドエラーが発生するか、現在のオブジェクトが最上位オブジェクトである場合にグローバルエラーが発生する可能性があります。- 次で指定:
- インターフェース
ErrorsのrejectValue - パラメーター:
field- フィールド名 (nullまたは空の文字列です)errorCode- エラーコード、メッセージキーとして解釈可能defaultMessage- フォールバックのデフォルトメッセージ- 関連事項:
rejectValue
public void rejectValue(@Nullable StringSE field, StringSE errorCode, @Nullable ObjectSE[] errorArgs, @Nullable StringSE defaultMessage) インターフェースからコピーされた説明:Errors指定されたエラーの説明を使用して、現在のオブジェクトの指定されたフィールドのフィールドエラーを登録します(存在する場合、現在のネストされたパスを考慮します)。フィールド名は
nullまたは空の文字列で、フィールドではなく現在のオブジェクト自体を示します。これにより、ネストされたオブジェクトグラフ内で対応するフィールドエラーが発生するか、現在のオブジェクトが最上位オブジェクトである場合にグローバルエラーが発生する可能性があります。- 次で指定:
- インターフェース
ErrorsのrejectValue - パラメーター:
field- フィールド名 (nullまたは空の文字列です)errorCode- エラーコード、メッセージキーとして解釈可能errorArgs- エラー引数、MessageFormat を介した引数バインディング用 (nullにすることができます)defaultMessage- フォールバックのデフォルトメッセージ- 関連事項:
addAllErrors
インターフェースからコピーされた説明:Errors指定されたErrorsインスタンスからのすべてのエラーをこのErrorsインスタンスに追加します。これは、
Errorsインスタンスを別のErrorsインスタンスにマージするために繰り返されるreject(..)呼び出しを避けるための便利なメソッドです。渡された
Errorsインスタンスは同じターゲットオブジェクトを参照するか、少なくともこのErrorsインスタンスのターゲットオブジェクトに適用される互換性のあるエラーを含むことに注意してください。- 次で指定:
- インターフェース
ErrorsのaddAllErrors - パラメーター:
errors- マージするErrorsインスタンス
hasErrors
public boolean hasErrors()インターフェースからコピーされた説明:Errorsエラーがあった場合に戻ります。getErrorCount
public int getErrorCount()インターフェースからコピーされた説明:Errorsエラーの総数を返します。- 次で指定:
- インターフェース
ErrorsのgetErrorCount
getAllErrors
インターフェースからコピーされた説明:Errorsグローバルエラーとフィールドエラーの両方のすべてのエラーを取得します。- 次で指定:
- インターフェース
ErrorsのgetAllErrors - 戻り値:
ObjectErrorインスタンスのリスト
hasGlobalErrors
public boolean hasGlobalErrors()インターフェースからコピーされた説明:Errorsグローバルエラーはありますか?- 次で指定:
- インターフェース
ErrorsのhasGlobalErrors - 戻り値:
- グローバルエラーがある場合は
true - 関連事項:
getGlobalErrorCount
public int getGlobalErrorCount()インターフェースからコピーされた説明:Errorsグローバルエラーの数を返します。- 次で指定:
- インターフェース
ErrorsのgetGlobalErrorCount - 戻り値:
- グローバルエラーの数
- 関連事項:
getGlobalErrors
インターフェースからコピーされた説明:Errorsすべてのグローバルエラーを取得します。- 次で指定:
- インターフェース
ErrorsのgetGlobalErrors - 戻り値:
ObjectErrorインスタンスのリスト
getGlobalError
インターフェースからコピーされた説明:Errorsもしあれば、 最初のグローバルエラーを取得します。- 次で指定:
- インターフェース
ErrorsのgetGlobalError - 戻り値:
- グローバルエラー、または
null
hasFieldErrors
public boolean hasFieldErrors()インターフェースからコピーされた説明:Errorsフィールドエラーはありますか?- 次で指定:
- インターフェース
ErrorsのhasFieldErrors - 戻り値:
- フィールドに関連するエラーがある場合は
true - 関連事項:
getFieldErrorCount
public int getFieldErrorCount()インターフェースからコピーされた説明:Errorsフィールドに関連付けられているエラーの数を返します。- 次で指定:
- インターフェース
ErrorsのgetFieldErrorCount - 戻り値:
- フィールドに関連付けられたエラーの数
- 関連事項:
getFieldErrors
インターフェースからコピーされた説明:Errorsフィールドに関連付けられているすべてのエラーを取得します。- 次で指定:
- インターフェース
ErrorsのgetFieldErrors - 戻り値:
FieldErrorインスタンスのリスト
getFieldError
インターフェースからコピーされた説明:Errorsフィールドに関連付けられている最初のエラーがあれば、それを取得します。- 次で指定:
- インターフェース
ErrorsのgetFieldError - 戻り値:
- フィールド固有のエラー、または
null
hasFieldErrors
インターフェースからコピーされた説明:Errors特定のフィールドに関連するエラーはありますか?- 次で指定:
- インターフェース
ErrorsのhasFieldErrors - パラメーター:
field- フィールド名- 戻り値:
- 指定されたフィールドに関連するエラーがある場合は、
true
getFieldErrorCount
インターフェースからコピーされた説明:Errors指定されたフィールドに関連付けられているエラーの数を返します。- 次で指定:
- インターフェース
ErrorsのgetFieldErrorCount - パラメーター:
field- フィールド名- 戻り値:
- 指定されたフィールドに関連付けられたエラーの数
getFieldErrors
インターフェースからコピーされた説明:Errors指定されたフィールドに関連するすべてのエラーを取得します。実装では、"name" などの完全なフィールド名だけでなく、"na *" や "address.*" などのパターン一致もサポートする必要があります。
- 次で指定:
- インターフェース
ErrorsのgetFieldErrors - パラメーター:
field- フィールド名- 戻り値:
FieldErrorインスタンスのリスト
getFieldError
インターフェースからコピーされた説明:Errors指定されたフィールドに関連付けられている最初のエラーがあれば、それを取得します。- 次で指定:
- インターフェース
ErrorsのgetFieldError - パラメーター:
field- フィールド名- 戻り値:
- フィールド固有のエラー、または
null
getFieldValue
インターフェースからコピーされた説明:Errors指定されたフィールドの現在の値、現在の Bean プロパティ値、最後のバインディングからの拒否された更新を返します。型の不一致があった場合でも、ユーザー指定のフィールド値に簡単にアクセスできます。
- 次で指定:
- インターフェース
ErrorsのgetFieldValue - パラメーター:
field- フィールド名- 戻り値:
- 指定されたフィールドの現在の値
getFieldType
インターフェースからコピーされた説明:Errors指定されたフィールドの型を返します。実装は、フィールド値が
nullの場合でも、たとえば関連する記述子から型を判別できる必要があります。- 次で指定:
- インターフェース
ErrorsのgetFieldType - パラメーター:
field- フィールド名- 戻り値:
- フィールドの型、または判別できない場合は
null
getTarget
インターフェースからコピーされた説明:BindingResult具体的なバインディング戦略に応じて、Bean、パブリックフィールドを持つオブジェクト、マップなどのラップされたターゲットオブジェクトを返します。- 次で指定:
- インターフェース
BindingResultのgetTarget
getModel
インターフェースからコピーされた説明:BindingResult取得した状態のモデルマップを返し、BindingResult インスタンスを 'MODEL_KEY_PREFIX+ objectName' として公開し、オブジェクト自体を 'objectName' として公開します。このメソッドを呼び出すたびにマップが作成されることに注意してください。マップに物事を追加してからこのメソッドを再度呼び出しても機能しません。
このメソッドによって返されるモデル Map の属性は、通常、BindingResult インスタンスへのアクセスが必要な JSP で Spring の
bindタグを使用するフォームビューのModelAndViewに含まれます。Spring の事前に構築されたフォームコントローラーは、フォームビューをレンダリングするときにこれを行います。ModelAndView インスタンスを自分で構築する場合、このメソッドによって返されるモデル Map の属性を含める必要があります。- 次で指定:
- インターフェース
BindingResultのgetModel - 関連事項:
getRawFieldValue
インターフェースからコピーされた説明:BindingResult指定されたフィールドの未加工フィールド値を抽出します。通常、比較目的で使用されます。- 次で指定:
- インターフェース
BindingResultのgetRawFieldValue - パラメーター:
field- チェックするフィールド- 戻り値:
- 未加工の形式のフィールドの現在の値、または不明の場合は
null
findEditor
インターフェースからコピーされた説明:BindingResult指定された型とプロパティのカスタムプロパティエディターを見つけます。- 次で指定:
- インターフェース
BindingResultのfindEditor - パラメーター:
field- プロパティのパス(名前またはネストされたパス)、または特定の型のすべてのプロパティのエディターを探している場合はnullvalueType- プロパティの型 (プロパティが指定されている場合はnullにすることができますが、一貫性チェックのためにいずれにしても指定する必要があります)- 戻り値:
- 登録されているエディター、または存在しない場合は
null
getPropertyEditorRegistry
インターフェースからコピーされた説明:BindingResult基になる PropertyEditorRegistry を返します。- 次で指定:
- インターフェース
BindingResultのgetPropertyEditorRegistry - 戻り値:
- PropertyEditorRegistry、またはこの BindingResult に使用可能なものがない場合は
null
resolveMessageCodes
インターフェースからコピーされた説明:BindingResult指定されたエラーコードをメッセージコードに解決します。適切なパラメーターを使用して、構成された
MessageCodesResolverを呼び出します。- 次で指定:
- インターフェース
BindingResultのresolveMessageCodes - パラメーター:
errorCode- メッセージコードに解決するエラーコード- 戻り値:
- 解決されたメッセージコード
resolveMessageCodes
インターフェースからコピーされた説明:BindingResult指定されたエラーコードを、指定されたフィールドのメッセージコードに解決します。適切なパラメーターを使用して、構成された
MessageCodesResolverを呼び出します。- 次で指定:
- インターフェース
BindingResultのresolveMessageCodes - パラメーター:
errorCode- メッセージコードに解決するエラーコードfield- メッセージコードを解決するフィールド- 戻り値:
- 解決されたメッセージコード
addError
インターフェースからコピーされた説明:BindingResult- 次で指定:
- インターフェース
BindingResultのaddError - 関連事項:
recordFieldValue
インターフェースからコピーされた説明:BindingResult指定されたフィールドに指定された値を記録します。ターゲットオブジェクトを構築できない場合に使用し、元のフィールド値を
Errors.getFieldValue(java.lang.String)で使用できるようにします。登録されたエラーの場合、拒否された値は影響を受けるフィールドごとに公開されます。- 次で指定:
- インターフェース
BindingResultのrecordFieldValue - パラメーター:
field- 値を記録するフィールドtype- フィールドの型value- 元の値
recordSuppressedField
インターフェースからコピーされた説明:BindingResult指定された許可されていないフィールドを非表示としてマークします。データバインダーは、許可されていないフィールドを対象として検出された各フィールド値に対してこれを呼び出します。
- 次で指定:
- インターフェース
BindingResultのrecordSuppressedField - 関連事項:
getSuppressedFields
インターフェースからコピーされた説明:BindingResultバインドプロセス中に抑制されたフィールドのリストを返します。フィールド値が許可されていないフィールドをターゲットとしていたかどうかを判断するために使用できます。
- 次で指定:
- インターフェース
BindingResultのgetSuppressedFields - 関連事項:
getMessage
このオブジェクトに保持されているエラーに関する診断情報を返します。- オーバーライド:
- クラス
ThrowableSEのgetMessage
equals
hashCode
public int hashCode()