パッケージ org.springframework.validation

インターフェース BindingResult

すべてのスーパーインターフェース:
Errors
すべての既知の実装クラス:
AbstractBindingResult、AbstractPropertyBindingResult、BeanPropertyBindingResult、BindException、DirectFieldBindingResult、MapBindingResult、MethodArgumentNotValidException、WebExchangeBindException
public interface BindingResult extends Errors
バインド結果を表す一般的なインターフェース。エラー登録機能のために Errors インターフェースを拡張し、Validator を適用できるようにし、バインディング固有の分析とモデル構築を追加します。

DataBinder.getBindingResult() メソッドを介して取得された DataBinder の結果ホルダーとして機能します。BindingResult 実装は、たとえば、Validator を呼び出すために直接使用することもできます (たとえば、単体テストの一部として)。

導入:
2.0
作成者:
Juergen Hoeller
関連事項:

  • フィールドの詳細

    • MODEL_KEY_PREFIX

      static final StringSE MODEL_KEY_PREFIX
      モデル内の BindingResult インスタンスの名前の接頭辞と、それに続くオブジェクト名。

  • メソッドの詳細

    • getTarget

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

    • getModel

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

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

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

      関連事項:

    • getRawFieldValue

      @Nullable ObjectSE getRawFieldValue(StringSE field)
      指定されたフィールドの未加工フィールド値を抽出します。通常、比較目的で使用されます。
      パラメーター:
      field - チェックするフィールド
      戻り値:
      未加工の形式のフィールドの現在の値、または不明の場合は null 

    • findEditor

      @Nullable PropertyEditorSE findEditor(@Nullable StringSE field, @Nullable ClassSE<?> valueType)
      指定された型とプロパティのカスタムプロパティエディターを見つけます。
      パラメーター:
      field - プロパティのパス（名前またはネストされたパス）、または特定の型のすべてのプロパティのエディターを探している場合は null 
      valueType - プロパティの型 (プロパティが指定されている場合は null にすることができますが、一貫性チェックのためにいずれにしても指定する必要があります)
      戻り値:
      登録されているエディター、または存在しない場合は null 

    • getPropertyEditorRegistry

      @Nullable PropertyEditorRegistry getPropertyEditorRegistry()
      基になる PropertyEditorRegistry を返します。
      戻り値:
      PropertyEditorRegistry、またはこの BindingResult に使用可能なものがない場合は null 

    • resolveMessageCodes

      StringSE[] resolveMessageCodes(StringSE errorCode)
      指定されたエラーコードをメッセージコードに解決します。

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

      パラメーター:
      errorCode - メッセージコードに解決するエラーコード
      戻り値:
      解決されたメッセージコード

    • resolveMessageCodes

      StringSE[] resolveMessageCodes(StringSE errorCode, StringSE field)
      指定されたエラーコードを、指定されたフィールドのメッセージコードに解決します。

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

      パラメーター:
      errorCode - メッセージコードに解決するエラーコード
      field - メッセージコードを解決するフィールド
      戻り値:
      解決されたメッセージコード

    • addError

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

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

      関連事項:

    • recordFieldValue

      default void recordFieldValue(StringSE field, ClassSE<?> type, @Nullable ObjectSE value)
      指定されたフィールドに指定された値を記録します。

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

      パラメーター:
      field - 値を記録するフィールド
      type - フィールドの型
      value - 元の値
      導入:
      5.0.4

    • recordSuppressedField

      default void recordSuppressedField(StringSE field)
      指定された許可されていないフィールドを非表示としてマークします。

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

      関連事項:

    • getSuppressedFields

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

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

      関連事項: