インターフェース Errors

メソッドの詳細

• getObjectName

  StringSE getObjectName()

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

• setNestedPath

  default void setNestedPath(StringSE nestedPath)

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

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

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

  パラメーター:

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

  関連事項:

  • getNestedPath()

• getNestedPath

  default StringSE getNestedPath()

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

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

  関連事項:

  • setNestedPath(String)

• pushNestedPath

  default void pushNestedPath(StringSE subPath)

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

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

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

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

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

  パラメーター:

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

  関連事項:

  • popNestedPath()

• popNestedPath

  default void popNestedPath() throws IllegalStateExceptionSE

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

  例外:

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

  関連事項:

  • pushNestedPath(String)

• reject

  default void reject(StringSE errorCode)

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

  パラメーター:

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

  関連事項:

  • reject(String, Object[], String)

• reject

  default void reject(StringSE errorCode, StringSE defaultMessage)

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

  パラメーター:

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

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

  関連事項:

  • reject(String, Object[], String)

• reject

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

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

  パラメーター:

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

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

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

  関連事項:

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

• rejectValue

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

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

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

  パラメーター:

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

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

  関連事項:

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

• rejectValue

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

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

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

  パラメーター:

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

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

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

  関連事項:

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

• rejectValue

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

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

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

  パラメーター:

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

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

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

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

  関連事項:

  • reject(String, Object[], String)

• addAllErrors

  default void addAllErrors(Errors errors)

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

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

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

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

  パラメーター:

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

  関連事項:

  • getAllErrors()

• failOnError

  default <T extends ThrowableSE> void failOnError(FunctionSE<StringSE,T> messageToException) throws T

  記録されたエラーを要約したメッセージとともにマップされた例外をスローします。

  型パラメーター:

  T - スローされる例外の型

  パラメーター:

  messageToException - メッセージを例外にマッピングする関数（例: IllegalArgumentException::new または IllegalStateException::new）

  例外:

  T extends ThrowableSE

  導入:

  6.1

  関連事項:

  • toString()

• hasErrors

  default boolean hasErrors()

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

  関連事項:

  • hasGlobalErrors()
  • hasFieldErrors()

• getErrorCount

  default int getErrorCount()

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

  関連事項:

  • getGlobalErrorCount()
  • getFieldErrorCount()

• getAllErrors

  default ListSE<ObjectError> getAllErrors()

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

  戻り値:

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

  関連事項:

  • getGlobalErrors()
  • getFieldErrors()

• hasGlobalErrors

  default boolean hasGlobalErrors()

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

  関連事項:

  • hasFieldErrors()

• getGlobalErrorCount

  default int getGlobalErrorCount()

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

  関連事項:

  • getFieldErrorCount()

• getGlobalErrors

  ListSE<ObjectError> getGlobalErrors()

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

  戻り値:

  ObjectError インスタンスのリスト

  関連事項:

  • getFieldErrors()

• getGlobalError

  @Nullable default ObjectError getGlobalError()

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

  戻り値:

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

  関連事項:

  • getFieldError()

• hasFieldErrors

  default boolean hasFieldErrors()

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

  関連事項:

  • hasGlobalErrors()

• getFieldErrorCount

  default int getFieldErrorCount()

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

  関連事項:

  • getGlobalErrorCount()

• getFieldErrors

  ListSE<FieldError> getFieldErrors()

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

  戻り値:

  FieldError インスタンスのリスト

  関連事項:

  • getGlobalErrors()

• getFieldError

  @Nullable default FieldError getFieldError()

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

  戻り値:

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

  関連事項:

  • getGlobalError()

• hasFieldErrors

  default boolean hasFieldErrors(StringSE field)

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

  パラメーター:

  field - フィールド名

  関連事項:

  • hasFieldErrors()

• getFieldErrorCount

  default int getFieldErrorCount(StringSE field)

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

  パラメーター:

  field - フィールド名

  関連事項:

  • getFieldErrorCount()

• getFieldErrors

  default ListSE<FieldError> getFieldErrors(StringSE field)

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

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

  パラメーター:

  field - フィールド名

  戻り値:

  FieldError インスタンスのリスト

  関連事項:

  • getFieldErrors()

• getFieldError

  @Nullable default FieldError getFieldError(StringSE field)

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

  パラメーター:

  field - フィールド名

  戻り値:

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

  関連事項:

  • getFieldError()

• getFieldValue

  @Nullable ObjectSE getFieldValue(StringSE field)

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

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

  パラメーター:

  field - フィールド名

  戻り値:

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

  関連事項:

  • getFieldType(String)

• getFieldType

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

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

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

  パラメーター:

  field - フィールド名

  戻り値:

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

  関連事項:

  • getFieldValue(String)

• toString

  StringSE toString()

  たとえば例外メッセージに含めるために、記録されたエラーの概要を返します。

  オーバーライド:

  クラス ObjectSE の toString 

  関連事項:

  • failOnError(Function)