クラス BindException

メソッドの詳細

• getBindingResult

  public final BindingResult getBindingResult()

  この BindException がラップする BindingResult を返します。

• getObjectName

  public StringSE getObjectName()

  インターフェースからコピーされた説明: Errors

  バインドされたルートオブジェクトの名前を返します。

  次で指定:

  インターフェース Errors の getObjectName 

• setNestedPath

  public void setNestedPath(StringSE nestedPath)

  インターフェースからコピーされた説明: Errors

  標準バリデーターがサブツリーを検証できるように、コンテキストの変更を許可します。呼び出しを拒否すると、指定されたパスがフィールド名の前に追加されます。

  例: 住所検証ツールは、顧客オブジェクトのサブオブジェクト「住所」を検証できます。

  すべての Errors 実装がネストされたパスをサポートしているわけではないため、デフォルトの実装では UnsupportedOperationException がスローされます。

  次で指定:

  インターフェース Errors の setNestedPath 

  パラメーター:

  nestedPath - このオブジェクト内のネストされたパス、たとえば "address" （デフォルトは ""、null も許容されます）。ドットで終わることができます。"address" と "address." の両方が有効です。

  関連事項:

  • Errors.getNestedPath()

• getNestedPath

  public StringSE getNestedPath()

  インターフェースからコピーされた説明: Errors

  この Errors オブジェクトの現在のネストされたパスを返します。

  連結されたパスを簡単に構築するために、ドット付きのネストされたパス、つまり「アドレス」を返します。デフォルトは空の文字列です。

  次で指定:

  インターフェース Errors の getNestedPath 

  関連事項:

  • Errors.setNestedPath(String)

• pushNestedPath

  public void pushNestedPath(StringSE subPath)

  インターフェースからコピーされた説明: Errors

  指定されたサブパスをネストされたパススタックにプッシュします。

  Errors.popNestedPath() 呼び出しは、対応する pushNestedPath(String) 呼び出しの前に元のネストされたパスをリセットします。

  ネストパススタックを使用すると、一時パスホルダーを気にすることなく、サブオブジェクトの一時ネストパスを設定できます。

  次に例を示します: 現在のパスは "spouse."、pushNestedPath("child" ) → 結果パスは "spouse.child."、popNestedPath() → 再び "spouse."

  すべての Errors 実装がネストされたパスをサポートしているわけではないため、デフォルトの実装では UnsupportedOperationException がスローされます。

  次で指定:

  インターフェース Errors の pushNestedPath 

  パラメーター:

  subPath - ネストされたパススタックにプッシュするサブパス

  関連事項:

  • Errors.popNestedPath()

• popNestedPath

  public void popNestedPath() throws IllegalStateExceptionSE

  インターフェースからコピーされた説明: Errors

  ネストされたパススタックから以前のネストされたパスをポップします。

  次で指定:

  インターフェース Errors の popNestedPath 

  例外:

  IllegalStateExceptionSE - スタックに元のネストされたパスがない場合

  関連事項:

  • Errors.pushNestedPath(String)

• reject

  public void reject(StringSE errorCode)

  インターフェースからコピーされた説明: Errors

  指定されたエラーの説明を使用して、ターゲットオブジェクト全体のグローバルエラーを登録します。

  次で指定:

  インターフェース Errors の reject 

  パラメーター:

  errorCode - エラーコード、メッセージキーとして解釈可能

  関連事項:

  • Errors.reject(String, Object[], String)

• reject

  public void reject(StringSE errorCode, StringSE defaultMessage)

  インターフェースからコピーされた説明: Errors

  指定されたエラーの説明を使用して、ターゲットオブジェクト全体のグローバルエラーを登録します。

  次で指定:

  インターフェース Errors の reject 

  パラメーター:

  errorCode - エラーコード、メッセージキーとして解釈可能

  defaultMessage - フォールバックのデフォルトメッセージ

  関連事項:

  • Errors.reject(String, Object[], String)

• reject

  public void reject(StringSE errorCode, ObjectSE @Nullable [] errorArgs, @Nullable StringSE defaultMessage)

  インターフェースからコピーされた説明: Errors

  指定されたエラーの説明を使用して、ターゲットオブジェクト全体のグローバルエラーを登録します。

  次で指定:

  インターフェース Errors の reject 

  パラメーター:

  errorCode - エラーコード、メッセージキーとして解釈可能

  errorArgs - エラー引数、MessageFormat を介した引数バインディング用 (null にすることができます)

  defaultMessage - フォールバックのデフォルトメッセージ

  関連事項:

  • Errors.rejectValue(String, String, Object[], String)

• rejectValue

  public void rejectValue(@Nullable StringSE field, StringSE errorCode)

  インターフェースからコピーされた説明: Errors

  指定されたエラーの説明を使用して、現在のオブジェクトの指定されたフィールドのフィールドエラーを登録します（存在する場合、現在のネストされたパスを考慮します）。

  フィールド名は null または空の文字列で、フィールドではなく現在のオブジェクト自体を示します。これにより、ネストされたオブジェクトグラフ内で対応するフィールドエラーが発生するか、現在のオブジェクトが最上位オブジェクトである場合にグローバルエラーが発生する可能性があります。

  次で指定:

  インターフェース Errors の rejectValue 

  パラメーター:

  field - フィールド名 (null または空の文字列です)

  errorCode - エラーコード、メッセージキーとして解釈可能

  関連事項:

  • Errors.rejectValue(String, String, Object[], String)

• rejectValue

  public void rejectValue(@Nullable StringSE field, StringSE errorCode, StringSE defaultMessage)

  インターフェースからコピーされた説明: Errors

  指定されたエラーの説明を使用して、現在のオブジェクトの指定されたフィールドのフィールドエラーを登録します（存在する場合、現在のネストされたパスを考慮します）。

  フィールド名は null または空の文字列で、フィールドではなく現在のオブジェクト自体を示します。これにより、ネストされたオブジェクトグラフ内で対応するフィールドエラーが発生するか、現在のオブジェクトが最上位オブジェクトである場合にグローバルエラーが発生する可能性があります。

  次で指定:

  インターフェース Errors の rejectValue 

  パラメーター:

  field - フィールド名 (null または空の文字列です)

  errorCode - エラーコード、メッセージキーとして解釈可能

  defaultMessage - フォールバックのデフォルトメッセージ

  関連事項:

  • Errors.rejectValue(String, String, Object[], String)

• rejectValue

  public void rejectValue(@Nullable StringSE field, StringSE errorCode, ObjectSE @Nullable [] errorArgs, @Nullable StringSE defaultMessage)

  インターフェースからコピーされた説明: Errors

  指定されたエラーの説明を使用して、現在のオブジェクトの指定されたフィールドのフィールドエラーを登録します（存在する場合、現在のネストされたパスを考慮します）。

  フィールド名は null または空の文字列で、フィールドではなく現在のオブジェクト自体を示します。これにより、ネストされたオブジェクトグラフ内で対応するフィールドエラーが発生するか、現在のオブジェクトが最上位オブジェクトである場合にグローバルエラーが発生する可能性があります。

  次で指定:

  インターフェース Errors の rejectValue 

  パラメーター:

  field - フィールド名 (null または空の文字列です)

  errorCode - エラーコード、メッセージキーとして解釈可能

  errorArgs - エラー引数、MessageFormat を介した引数バインディング用 (null にすることができます)

  defaultMessage - フォールバックのデフォルトメッセージ

  関連事項:

  • Errors.reject(String, Object[], String)

• addAllErrors

  public void addAllErrors(Errors errors)

  インターフェースからコピーされた説明: Errors

  指定された Errors インスタンスからのすべてのエラーをこの Errors インスタンスに追加します。

  これは、Errors インスタンスを別の Errors インスタンスにマージするために繰り返される reject(..) 呼び出しを避けるための便利なメソッドです。

  渡された Errors インスタンスは同じターゲットオブジェクトを参照するか、少なくともこの Errors インスタンスのターゲットオブジェクトに適用される互換性のあるエラーを含むことに注意してください。

  すべての Errors 実装が #addAllErrors をサポートしているわけではないため、デフォルトの実装では UnsupportedOperationException がスローされます。

  次で指定:

  インターフェース Errors の addAllErrors 

  パラメーター:

  errors - マージする Errors インスタンス

  関連事項:

  • Errors.getAllErrors()

• hasErrors

  public boolean hasErrors()

  インターフェースからコピーされた説明: Errors

  エラーがあったかどうかを確認します。

  次で指定:

  インターフェース Errors の hasErrors 

  関連事項:

  • Errors.hasGlobalErrors()
  • Errors.hasFieldErrors()

• getErrorCount

  public int getErrorCount()

  インターフェースからコピーされた説明: Errors

  エラーの合計数を確認します。

  次で指定:

  インターフェース Errors の getErrorCount 

  関連事項:

  • Errors.getGlobalErrorCount()
  • Errors.getFieldErrorCount()

• getAllErrors

  public ListSE<ObjectError> getAllErrors()

  インターフェースからコピーされた説明: Errors

  グローバルエラーとフィールドエラーの両方のすべてのエラーを取得します。

  次で指定:

  インターフェース Errors の getAllErrors 

  戻り値:

  ObjectError/FieldError インスタンスのリスト

  関連事項:

  • Errors.getGlobalErrors()
  • Errors.getFieldErrors()

• hasGlobalErrors

  public boolean hasGlobalErrors()

  インターフェースからコピーされた説明: Errors

  グローバルエラーがあったかどうかを確認します。

  次で指定:

  インターフェース Errors の hasGlobalErrors 

  関連事項:

  • Errors.hasFieldErrors()

• getGlobalErrorCount

  public int getGlobalErrorCount()

  インターフェースからコピーされた説明: Errors

  グローバルエラーの数を確認します。

  次で指定:

  インターフェース Errors の getGlobalErrorCount 

  関連事項:

  • Errors.getFieldErrorCount()

• getGlobalErrors

  public ListSE<ObjectError> getGlobalErrors()

  インターフェースからコピーされた説明: Errors

  すべてのグローバルエラーを取得します。

  次で指定:

  インターフェース Errors の getGlobalErrors 

  戻り値:

  ObjectError インスタンスのリスト

  関連事項:

  • Errors.getFieldErrors()

• getGlobalError

  public @Nullable ObjectError getGlobalError()

  インターフェースからコピーされた説明: Errors

  もしあれば、 最初のグローバルエラーを取得します。

  次で指定:

  インターフェース Errors の getGlobalError 

  戻り値:

  グローバルエラー、または null

  関連事項:

  • Errors.getFieldError()

• hasFieldErrors

  public boolean hasFieldErrors()

  インターフェースからコピーされた説明: Errors

  フィールドに関連するエラーがあったかどうかを確認します。

  次で指定:

  インターフェース Errors の hasFieldErrors 

  関連事項:

  • Errors.hasGlobalErrors()

• getFieldErrorCount

  public int getFieldErrorCount()

  インターフェースからコピーされた説明: Errors

  フィールドに関連付けられたエラーの数を確認します。

  次で指定:

  インターフェース Errors の getFieldErrorCount 

  関連事項:

  • Errors.getGlobalErrorCount()

• getFieldErrors

  public ListSE<FieldError> getFieldErrors()

  インターフェースからコピーされた説明: Errors

  フィールドに関連付けられているすべてのエラーを取得します。

  次で指定:

  インターフェース Errors の getFieldErrors 

  戻り値:

  FieldError インスタンスのリスト

  関連事項:

  • Errors.getGlobalErrors()

• getFieldError

  public @Nullable FieldError getFieldError()

  インターフェースからコピーされた説明: Errors

  フィールドに関連付けられている最初のエラーがあれば、それを取得します。

  次で指定:

  インターフェース Errors の getFieldError 

  戻り値:

  フィールド固有のエラー、または null

  関連事項:

  • Errors.getGlobalError()

• hasFieldErrors

  public boolean hasFieldErrors(StringSE field)

  インターフェースからコピーされた説明: Errors

  指定されたフィールドに関連するエラーがあったかどうかを確認します。

  次で指定:

  インターフェース Errors の hasFieldErrors 

  パラメーター:

  field - フィールド名

  関連事項:

  • Errors.hasFieldErrors()

• getFieldErrorCount

  public int getFieldErrorCount(StringSE field)

  インターフェースからコピーされた説明: Errors

  指定されたフィールドに関連付けられたエラーの数を確認します。

  次で指定:

  インターフェース Errors の getFieldErrorCount 

  パラメーター:

  field - フィールド名

  関連事項:

  • Errors.getFieldErrorCount()

• getFieldErrors

  public ListSE<FieldError> getFieldErrors(StringSE field)

  インターフェースからコピーされた説明: Errors

  指定されたフィールドに関連するすべてのエラーを取得します。

  実装では、"address.street" のような完全なフィールド名だけでなく、"address.*" のようなパターンマッチもサポートする場合があります。

  次で指定:

  インターフェース Errors の getFieldErrors 

  パラメーター:

  field - フィールド名

  戻り値:

  FieldError インスタンスのリスト

  関連事項:

  • Errors.getFieldErrors()

• getFieldError

  public @Nullable FieldError getFieldError(StringSE field)

  インターフェースからコピーされた説明: Errors

  指定されたフィールドに関連付けられている最初のエラーがあれば、それを取得します。

  次で指定:

  インターフェース Errors の getFieldError 

  パラメーター:

  field - フィールド名

  戻り値:

  フィールド固有のエラー、または null

  関連事項:

  • Errors.getFieldError()

• getFieldValue

  public @Nullable ObjectSE getFieldValue(StringSE field)

  インターフェースからコピーされた説明: Errors

  指定されたフィールドの現在の値、現在の Bean プロパティ値、最後のバインディングからの拒否された更新を返します。

  型の不一致があった場合でも、ユーザー指定のフィールド値に簡単にアクセスできます。

  次で指定:

  インターフェース Errors の getFieldValue 

  パラメーター:

  field - フィールド名

  戻り値:

  指定されたフィールドの現在の値

  関連事項:

  • Errors.getFieldType(String)

• getFieldType

  public @Nullable ClassSE<?> getFieldType(StringSE field)

  インターフェースからコピーされた説明: Errors

  指定されたフィールドの型を可能な限り特定します。

  実装は、フィールド値が null の場合でも、たとえば関連する記述子から型を判別できる必要があります。

  次で指定:

  インターフェース Errors の getFieldType 

  パラメーター:

  field - フィールド名

  戻り値:

  フィールドの型、または判別できない場合は null 

  関連事項:

  • Errors.getFieldValue(String)

• getTarget

  public @Nullable ObjectSE getTarget()

  インターフェースからコピーされた説明: BindingResult

  具体的なバインディング戦略に応じて、Bean、パブリックフィールドを持つオブジェクト、マップなどのラップされたターゲットオブジェクトを返します。

  次で指定:

  インターフェース BindingResult の getTarget 

• getModel

  public MapSE<StringSE,ObjectSE> getModel()

  インターフェースからコピーされた説明: BindingResult

  取得した状態のモデルマップを返し、BindingResult インスタンスを 'MODEL_KEY_PREFIX + objectName' として公開し、オブジェクト自体を 'objectName' として公開します。

  このメソッドを呼び出すたびにマップが作成されることに注意してください。マップに物事を追加してからこのメソッドを再度呼び出しても機能しません。

  このメソッドによって返されるモデル Map の属性は、通常、BindingResult インスタンスへのアクセスが必要な JSP で Spring の bind タグを使用するフォームビューの ModelAndView に含まれます。Spring の事前に構築されたフォームコントローラーは、フォームビューをレンダリングするときにこれを行います。ModelAndView インスタンスを自分で構築する場合、このメソッドによって返されるモデル Map の属性を含める必要があります。

  次で指定:

  インターフェース BindingResult の getModel 

  関連事項:

  • Errors.getObjectName()
  • BindingResult.MODEL_KEY_PREFIX
  • ModelAndView
  • BindTag

• getRawFieldValue

  public @Nullable ObjectSE getRawFieldValue(StringSE field)

  インターフェースからコピーされた説明: BindingResult

  指定されたフィールドの未加工フィールド値を抽出します。通常、比較目的で使用されます。

  次で指定:

  インターフェース BindingResult の getRawFieldValue 

  パラメーター:

  field - チェックするフィールド

  戻り値:

  未加工の形式のフィールドの現在の値、または不明の場合は null 

• findEditor

  public @Nullable PropertyEditorSE findEditor(@Nullable StringSE field, @Nullable ClassSE valueType)

  インターフェースからコピーされた説明: BindingResult

  指定された型とプロパティのカスタムプロパティエディターを見つけます。

  次で指定:

  インターフェース BindingResult の findEditor 

  パラメーター:

  field - プロパティのパス（名前またはネストされたパス）、または特定の型のすべてのプロパティのエディターを探している場合は null 

  valueType - プロパティの型 (プロパティが指定されている場合は null にすることができますが、一貫性チェックのためにいずれにしても指定する必要があります)

  戻り値:

  登録されているエディター、または存在しない場合は null 

• getPropertyEditorRegistry

  public @Nullable PropertyEditorRegistry getPropertyEditorRegistry()

  インターフェースからコピーされた説明: BindingResult

  基になる PropertyEditorRegistry を返します。

  次で指定:

  インターフェース BindingResult の getPropertyEditorRegistry 

  戻り値:

  PropertyEditorRegistry、またはこの BindingResult に使用可能なものがない場合は null 

• resolveMessageCodes

  public StringSE[] resolveMessageCodes(StringSE errorCode)

  インターフェースからコピーされた説明: BindingResult

  指定されたエラーコードをメッセージコードに解決します。

  適切なパラメーターを使用して、構成された MessageCodesResolver を呼び出します。

  次で指定:

  インターフェース BindingResult の resolveMessageCodes 

  パラメーター:

  errorCode - メッセージコードに解決するエラーコード

  戻り値:

  解決されたメッセージコード

• resolveMessageCodes

  public StringSE[] resolveMessageCodes(StringSE errorCode, StringSE field)

  インターフェースからコピーされた説明: BindingResult

  指定されたエラーコードを、指定されたフィールドのメッセージコードに解決します。

  適切なパラメーターを使用して、構成された MessageCodesResolver を呼び出します。

  次で指定:

  インターフェース BindingResult の resolveMessageCodes 

  パラメーター:

  errorCode - メッセージコードに解決するエラーコード

  field - メッセージコードを解決するフィールド

  戻り値:

  解決されたメッセージコード

• addError

  public void addError(ObjectError error)

  インターフェースからコピーされた説明: BindingResult

  カスタム ObjectError または FieldError をエラーリストに追加します。

  BindingErrorProcessor などの協力戦略によって使用されることを目的としています。

  次で指定:

  インターフェース BindingResult の addError 

  関連事項:

  • ObjectError
  • FieldError
  • BindingErrorProcessor

• recordFieldValue

  public void recordFieldValue(StringSE field, ClassSE<?> type, @Nullable ObjectSE value)

  インターフェースからコピーされた説明: BindingResult

  指定されたフィールドに指定された値を記録します。

  ターゲットオブジェクトを構築できない場合に使用し、元のフィールド値を Errors.getFieldValue(String) で使用できるようにします。登録されたエラーの場合、拒否された値は影響を受けるフィールドごとに公開されます。

  次で指定:

  インターフェース BindingResult の recordFieldValue 

  パラメーター:

  field - 値を記録するフィールド

  type - フィールドの型

  value - 元の値

• recordSuppressedField

  public void recordSuppressedField(StringSE field)

  インターフェースからコピーされた説明: BindingResult

  指定された許可されていないフィールドを非表示としてマークします。

  データバインダーは、許可されていないフィールドを対象として検出された各フィールド値に対してこれを呼び出します。

  次で指定:

  インターフェース BindingResult の recordSuppressedField 

  関連事項:

  • DataBinder.setAllowedFields(String...)

• getSuppressedFields

  public StringSE[] getSuppressedFields()

  インターフェースからコピーされた説明: BindingResult

  バインドプロセス中に抑制されたフィールドのリストを返します。

  フィールド値が許可されていないフィールドをターゲットとしていたかどうかを判断するために使用できます。

  次で指定:

  インターフェース BindingResult の getSuppressedFields 

  関連事項:

  • DataBinder.setAllowedFields(String...)

• getMessage

  public StringSE getMessage()

  このオブジェクトに保持されているエラーに関する診断情報を返します。

  オーバーライド:

  クラス ThrowableSE の getMessage 

• equals

  public boolean equals(@Nullable ObjectSE other)

  オーバーライド:

  クラス ObjectSE の equalsSE 

• hashCode

  public int hashCode()

  オーバーライド:

  クラス ObjectSE の hashCode