クラス AbstractBindingResult

java.lang.ObjectSE
org.springframework.validation.AbstractErrors
org.springframework.validation.AbstractBindingResult
実装されたすべてのインターフェース:
SerializableSEBindingResultErrors
既知の直属サブクラス
AbstractPropertyBindingResultMapBindingResult

public abstract class AbstractBindingResult extends AbstractErrors implements BindingResult, SerializableSE
BindingResult インターフェースとそのスーパーインターフェース Errors の抽象的な実装。ObjectErrors および FieldErrors の共通管理をカプセル化します。
導入:
2.0
作成者:
Juergen Hoeller, Rob Harrop
関連事項:
  • コンストラクターの詳細

    • AbstractBindingResult

      protected AbstractBindingResult(StringSE objectName)
      新しい AbstractBindingResult インスタンスを作成します。
      パラメーター:
      objectName - ターゲットオブジェクトの名前
      関連事項:
  • メソッドの詳細

    • setMessageCodesResolver

      public void setMessageCodesResolver(MessageCodesResolver messageCodesResolver)
      エラーをメッセージコードに解決するために使用する戦略を設定します。デフォルトは DefaultMessageCodesResolver です。
      関連事項:
    • getMessageCodesResolver

      public MessageCodesResolver getMessageCodesResolver()
      エラーをメッセージコードに解決するために使用する戦略を返します。
    • getObjectName

      public StringSE getObjectName()
      インターフェースからコピーされた説明: Errors
      バインドされたルートオブジェクトの名前を返します。
      次で指定:
      インターフェース ErrorsgetObjectName 
    • reject

      public void reject(StringSE errorCode, @Nullable ObjectSE[] errorArgs, @Nullable StringSE defaultMessage)
      インターフェースからコピーされた説明: Errors
      指定されたエラーの説明を使用して、ターゲットオブジェクト全体のグローバルエラーを登録します。
      次で指定:
      インターフェース Errorsreject 
      パラメーター:
      errorCode - エラーコード、メッセージキーとして解釈可能
      errorArgs - エラー引数、MessageFormat を介した引数バインディング用 (null にすることができます)
      defaultMessage - フォールバックのデフォルトメッセージ
      関連事項:
    • rejectValue

      public void rejectValue(@Nullable StringSE field, StringSE errorCode, @Nullable ObjectSE[] errorArgs, @Nullable StringSE defaultMessage)
      インターフェースからコピーされた説明: Errors
      指定されたエラーの説明を使用して、現在のオブジェクトの指定されたフィールドのフィールドエラーを登録します(存在する場合、現在のネストされたパスを考慮します)。

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

      次で指定:
      インターフェース ErrorsrejectValue 
      パラメーター:
      field - フィールド名 (null または空の文字列です)
      errorCode - エラーコード、メッセージキーとして解釈可能
      errorArgs - エラー引数、MessageFormat を介した引数バインディング用 (null にすることができます)
      defaultMessage - フォールバックのデフォルトメッセージ
      関連事項:
    • addAllErrors

      public void addAllErrors(Errors errors)
      インターフェースからコピーされた説明: Errors
      指定された Errors インスタンスからのすべてのエラーをこの Errors インスタンスに追加します。

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

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

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

      次で指定:
      インターフェース ErrorsaddAllErrors 
      パラメーター:
      errors - マージする Errors インスタンス
      関連事項:
    • hasErrors

      public boolean hasErrors()
      インターフェースからコピーされた説明: Errors
      エラーがあったかどうかを確認します。
      次で指定:
      インターフェース ErrorshasErrors 
      関連事項:
    • getErrorCount

      public int getErrorCount()
      インターフェースからコピーされた説明: Errors
      エラーの合計数を確認します。
      次で指定:
      インターフェース ErrorsgetErrorCount 
      関連事項:
    • getAllErrors

      public ListSE<ObjectError> getAllErrors()
      インターフェースからコピーされた説明: Errors
      グローバルエラーとフィールドエラーの両方のすべてのエラーを取得します。
      次で指定:
      インターフェース ErrorsgetAllErrors 
      戻り値:
      ObjectError/FieldError インスタンスのリスト
      関連事項:
    • getGlobalErrors

      public ListSE<ObjectError> getGlobalErrors()
      インターフェースからコピーされた説明: Errors
      すべてのグローバルエラーを取得します。
      次で指定:
      インターフェース ErrorsgetGlobalErrors 
      戻り値:
      ObjectError インスタンスのリスト
      関連事項:
    • getGlobalError

      @Nullable public ObjectError getGlobalError()
      インターフェースからコピーされた説明: Errors
      もしあれば、 最初のグローバルエラーを取得します。
      次で指定:
      インターフェース ErrorsgetGlobalError 
      戻り値:
      グローバルエラー、または null
      関連事項:
    • getFieldErrors

      public ListSE<FieldError> getFieldErrors()
      インターフェースからコピーされた説明: Errors
      フィールドに関連付けられているすべてのエラーを取得します。
      次で指定:
      インターフェース ErrorsgetFieldErrors 
      戻り値:
      FieldError インスタンスのリスト
      関連事項:
    • getFieldError

      @Nullable public FieldError getFieldError()
      インターフェースからコピーされた説明: Errors
      フィールドに関連付けられている最初のエラーがあれば、それを取得します。
      次で指定:
      インターフェース ErrorsgetFieldError 
      戻り値:
      フィールド固有のエラー、または null
      関連事項:
    • getFieldErrors

      public ListSE<FieldError> getFieldErrors(StringSE field)
      インターフェースからコピーされた説明: Errors
      指定されたフィールドに関連するすべてのエラーを取得します。

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

      次で指定:
      インターフェース ErrorsgetFieldErrors 
      オーバーライド:
      クラス AbstractErrorsgetFieldErrors 
      パラメーター:
      field - フィールド名
      戻り値:
      FieldError インスタンスのリスト
      関連事項:
    • getFieldError

      @Nullable public FieldError getFieldError(StringSE field)
      インターフェースからコピーされた説明: Errors
      指定されたフィールドに関連付けられている最初のエラーがあれば、それを取得します。
      次で指定:
      インターフェース ErrorsgetFieldError 
      パラメーター:
      field - フィールド名
      戻り値:
      フィールド固有のエラー、または null
      関連事項:
    • getFieldValue

      @Nullable public ObjectSE getFieldValue(StringSE field)
      インターフェースからコピーされた説明: Errors
      指定されたフィールドの現在の値、現在の Bean プロパティ値、最後のバインディングからの拒否された更新を返します。

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

      次で指定:
      インターフェース ErrorsgetFieldValue 
      パラメーター:
      field - フィールド名
      戻り値:
      指定されたフィールドの現在の値
      関連事項:
    • getFieldType

      @Nullable public ClassSE<?> getFieldType(@Nullable StringSE field)
      このデフォルトの実装は、実際のフィールド値がある場合、その値に基づいて型を決定します。サブクラスは、null 値であっても、記述子から型を決定するためにこれをオーバーライドする必要があります。
      次で指定:
      インターフェース ErrorsgetFieldType 
      パラメーター:
      field - フィールド名
      戻り値:
      フィールドの型、または判別できない場合は null 
      関連事項:
    • getModel

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

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

      このメソッドによって返されるモデルマップの属性は、通常、Spring のバインドタグを使用するフォームビューの ModelAndView に含まれています。これは、エラーインスタンスへのアクセスを必要とします。

      次で指定:
      インターフェース BindingResultgetModel 
      関連事項:
    • getRawFieldValue

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

      @Nullable public PropertyEditorSE findEditor(@Nullable StringSE field, @Nullable ClassSE<?> valueType)
      この実装は、可能であれば、PropertyEditorRegistry のエディター検索機能に委譲します。
      次で指定:
      インターフェース BindingResultfindEditor 
      パラメーター:
      field - プロパティのパス(名前またはネストされたパス)、または特定の型のすべてのプロパティのエディターを探している場合は null 
      valueType - プロパティの型 (プロパティが指定されている場合は null にすることができますが、一貫性チェックのためにいずれにしても指定する必要があります)
      戻り値:
      登録されているエディター、または存在しない場合は null 
    • getPropertyEditorRegistry

      @Nullable public PropertyEditorRegistry getPropertyEditorRegistry()
      この実装は null を返します。
      次で指定:
      インターフェース BindingResultgetPropertyEditorRegistry 
      戻り値:
      PropertyEditorRegistry、またはこの BindingResult に使用可能なものがない場合は null 
    • resolveMessageCodes

      public StringSE[] resolveMessageCodes(StringSE errorCode)
      インターフェースからコピーされた説明: BindingResult
      指定されたエラーコードをメッセージコードに解決します。

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

      次で指定:
      インターフェース BindingResultresolveMessageCodes 
      パラメーター:
      errorCode - メッセージコードに解決するエラーコード
      戻り値:
      解決されたメッセージコード
    • resolveMessageCodes

      public StringSE[] resolveMessageCodes(StringSE errorCode, @Nullable StringSE field)
      インターフェースからコピーされた説明: BindingResult
      指定されたエラーコードを、指定されたフィールドのメッセージコードに解決します。

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

      次で指定:
      インターフェース BindingResultresolveMessageCodes 
      パラメーター:
      errorCode - メッセージコードに解決するエラーコード
      field - メッセージコードを解決するフィールド
      戻り値:
      解決されたメッセージコード
    • addError

      public void addError(ObjectError error)
      インターフェースからコピーされた説明: BindingResult
      カスタム ObjectError または FieldError をエラーリストに追加します。

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

      次で指定:
      インターフェース BindingResultaddError 
      関連事項:
    • recordFieldValue

      public void recordFieldValue(StringSE field, ClassSE<?> type, @Nullable ObjectSE value)
      インターフェースからコピーされた説明: BindingResult
      指定されたフィールドに指定された値を記録します。

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

      次で指定:
      インターフェース BindingResultrecordFieldValue 
      パラメーター:
      field - 値を記録するフィールド
      type - フィールドの型
      value - 元の値
    • recordSuppressedField

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

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

      次で指定:
      インターフェース BindingResultrecordSuppressedField 
      関連事項:
    • getSuppressedFields

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

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

      次で指定:
      インターフェース BindingResultgetSuppressedFields 
      関連事項:
    • equals

      public boolean equals(@Nullable ObjectSE other)
      オーバーライド:
      クラス ObjectSEequalsSE 
    • hashCode

      public int hashCode()
      オーバーライド:
      クラス ObjectSEhashCode 
    • getTarget

      @Nullable public abstract ObjectSE getTarget()
      ラップされたターゲットオブジェクトを返します。
      次で指定:
      インターフェース BindingResultgetTarget 
    • getActualFieldValue

      @Nullable protected abstract ObjectSE getActualFieldValue(StringSE field)
      指定されたフィールドの実際のフィールド値を抽出します。
      パラメーター:
      field - チェックするフィールド
      戻り値:
      フィールドの現在の値
    • formatFieldValue

      @Nullable protected ObjectSE formatFieldValue(StringSE field, @Nullable ObjectSE value)
      指定されたフィールドの指定された値をフォーマットします。

      デフォルトの実装では、フィールド値をそのまま返します。

      パラメーター:
      field - チェックするフィールド
      value - フィールドの値 (バインディングエラー以外の拒否された値、または実際のフィールド値)
      戻り値:
      フォーマットされた値