クラス ParameterErrors

実装されたすべてのインターフェース:
Errors

public class ParameterErrors extends ParameterValidationResult implements Errors
オブジェクトメソッドのパラメーターまたはプロパティにネストされたエラーを含む戻り値用に作成された ParameterValidationResult の拡張機能。

基本クラスのメソッド ParameterValidationResult.getResolvableErrors()Errors.getAllErrors() を返しますが、このサブクラスは FieldError と同じものへのアクセスを提供します。

導入:
6.1
作成者:
Rossen Stoyanchev
  • フィールドサマリー

    インターフェース org.springframework.validation.Errors から継承されたフィールド

    NESTED_PATH_SEPARATOR
  • コンストラクターのサマリー

    コンストラクター
    コンストラクター
    説明
    ParameterErrors(MethodParameter parameter, ObjectSE argument, Errors errors, ObjectSE container, IntegerSE index, ObjectSE key)
    ParameterErrors を作成します。
  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    void
    指定された Errors インスタンスからのすべてのエラーをこの Errors インスタンスに追加します。
    グローバルエラーとフィールドエラーの両方のすべてのエラーを取得します。
    int
    エラーの合計数を確認します。
    フィールドに関連付けられている最初のエラーがあれば、それを取得します。
    指定されたフィールドに関連付けられている最初のエラーがあれば、それを取得します。
    int
    フィールドに関連付けられたエラーの数を確認します。
    int
    指定されたフィールドに関連付けられたエラーの数を確認します。
    フィールドに関連付けられているすべてのエラーを取得します。
    指定されたフィールドに関連するすべてのエラーを取得します。
    指定されたフィールドの型を可能な限り特定します。
    指定されたフィールドの現在の値、現在の Bean プロパティ値、最後のバインディングからの拒否された更新を返します。
    もしあれば、 最初のグローバルエラーを取得します。
    int
    グローバルエラーの数を確認します。
    すべてのグローバルエラーを取得します。
    この Errors オブジェクトの現在のネストされたパスを返します。
    バインドされたルートオブジェクトの名前を返します。
    boolean
    エラーがあったかどうかを確認します。
    boolean
    フィールドに関連するエラーがあったかどうかを確認します。
    boolean
    指定されたフィールドに関連するエラーがあったかどうかを確認します。
    boolean
    グローバルエラーがあったかどうかを確認します。
    void
    ネストされたパススタックから以前のネストされたパスをポップします。
    void
    指定されたサブパスをネストされたパススタックにプッシュします。
    void
    reject(StringSE errorCode)
    指定されたエラーの説明を使用して、ターゲットオブジェクト全体のグローバルエラーを登録します。
    void
    reject(StringSE errorCode, ObjectSE[] errorArgs, StringSE defaultMessage)
    指定されたエラーの説明を使用して、ターゲットオブジェクト全体のグローバルエラーを登録します。
    void
    reject(StringSE errorCode, StringSE defaultMessage)
    指定されたエラーの説明を使用して、ターゲットオブジェクト全体のグローバルエラーを登録します。
    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
    標準バリデーターがサブツリーを検証できるように、コンテキストの変更を許可します。

    クラス org.springframework.validation.method.ParameterValidationResult から継承されたメソッド

    equals, getArgument, getContainer, getContainerIndex, getContainerKey, getMethodParameter, getResolvableErrors, hashCode, toString

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, finalize, getClass, notify, notifyAll, wait, waitSE, waitSE

    インターフェース org.springframework.validation.Errors から継承されたメソッド

    failOnError, toString
  • コンストラクターの詳細

  • メソッドの詳細

    • getObjectName

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

      public void setNestedPath(StringSE nestedPath)
      インターフェースからコピーされた説明: Errors
      標準バリデーターがサブツリーを検証できるように、コンテキストの変更を許可します。呼び出しを拒否すると、指定されたパスがフィールド名の前に追加されます。

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

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

      次で指定:
      インターフェース ErrorssetNestedPath 
      パラメーター:
      nestedPath - このオブジェクト内のネストされたパス。「アドレス」(デフォルトは ""、null も使用可能)。「アドレス」と「アドレス」の両方で終わることができます。有効です。
      関連事項:
    • getNestedPath

      public StringSE getNestedPath()
      インターフェースからコピーされた説明: Errors
      この Errors オブジェクトの現在のネストされたパスを返します。

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

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

      public void pushNestedPath(StringSE subPath)
      インターフェースからコピーされた説明: Errors
      指定されたサブパスをネストされたパススタックにプッシュします。

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

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

      次に例を示します: 現在のパス "spouse。"、pushNestedPath("child" )→ 結果パス "spouse.child。"; popNestedPath()→ " 配偶者。" また。

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

      次で指定:
      インターフェース ErrorspushNestedPath 
      パラメーター:
      subPath - ネストされたパススタックにプッシュするサブパス
      関連事項:
    • popNestedPath

      public void popNestedPath() throws IllegalStateExceptionSE
      インターフェースからコピーされた説明: Errors
      ネストされたパススタックから以前のネストされたパスをポップします。
      次で指定:
      インターフェース ErrorspopNestedPath 
      例外:
      IllegalStateExceptionSE - スタックに元のネストされたパスがない場合
      関連事項:
    • reject

      public void reject(StringSE errorCode)
      インターフェースからコピーされた説明: Errors
      指定されたエラーの説明を使用して、ターゲットオブジェクト全体のグローバルエラーを登録します。
      次で指定:
      インターフェース Errorsreject 
      パラメーター:
      errorCode - エラーコード、メッセージキーとして解釈可能
      関連事項:
    • reject

      public void reject(StringSE errorCode, StringSE defaultMessage)
      インターフェースからコピーされた説明: Errors
      指定されたエラーの説明を使用して、ターゲットオブジェクト全体のグローバルエラーを登録します。
      次で指定:
      インターフェース Errorsreject 
      パラメーター:
      errorCode - エラーコード、メッセージキーとして解釈可能
      defaultMessage - フォールバックのデフォルトメッセージ
      関連事項:
    • 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)
      インターフェースからコピーされた説明: Errors
      指定されたエラーの説明を使用して、現在のオブジェクトの指定されたフィールドのフィールドエラーを登録します(存在する場合、現在のネストされたパスを考慮します)。

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

      次で指定:
      インターフェース ErrorsrejectValue 
      パラメーター:
      field - フィールド名 (null または空の文字列です)
      errorCode - エラーコード、メッセージキーとして解釈可能
      関連事項:
    • rejectValue

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

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

      次で指定:
      インターフェース ErrorsrejectValue 
      パラメーター:
      field - フィールド名 (null または空の文字列です)
      errorCode - エラーコード、メッセージキーとして解釈可能
      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 インスタンスのリスト
      関連事項:
    • hasGlobalErrors

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

      public int getGlobalErrorCount()
      インターフェースからコピーされた説明: Errors
      グローバルエラーの数を確認します。
      次で指定:
      インターフェース ErrorsgetGlobalErrorCount 
      関連事項:
    • getGlobalErrors

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

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

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

      public int getFieldErrorCount()
      インターフェースからコピーされた説明: Errors
      フィールドに関連付けられたエラーの数を確認します。
      次で指定:
      インターフェース ErrorsgetFieldErrorCount 
      関連事項:
    • getFieldErrors

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

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

      public boolean hasFieldErrors(StringSE field)
      インターフェースからコピーされた説明: Errors
      指定されたフィールドに関連するエラーがあったかどうかを確認します。
      次で指定:
      インターフェース ErrorshasFieldErrors 
      パラメーター:
      field - フィールド名
      関連事項:
    • getFieldErrorCount

      public int getFieldErrorCount(StringSE field)
      インターフェースからコピーされた説明: Errors
      指定されたフィールドに関連付けられたエラーの数を確認します。
      次で指定:
      インターフェース ErrorsgetFieldErrorCount 
      パラメーター:
      field - フィールド名
      関連事項:
    • getFieldErrors

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

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

      次で指定:
      インターフェース ErrorsgetFieldErrors 
      パラメーター:
      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(StringSE field)
      インターフェースからコピーされた説明: Errors
      指定されたフィールドの型を可能な限り特定します。

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

      次で指定:
      インターフェース ErrorsgetFieldType 
      パラメーター:
      field - フィールド名
      戻り値:
      フィールドの型、または判別できない場合は null 
      関連事項: