public interface Errors
フィールド名は、ターゲットオブジェクトのプロパティ(例: 顧客オブジェクトにバインドするときの「名前」)、またはサブオブジェクトの場合はネストされたフィールド(例: "address.street" )にすることができます。setNestedPath(String)
を介したサブツリーナビゲーションをサポートします。たとえば、AddressValidator
は「住所」を検証しますが、これが顧客のサブオブジェクトであることを認識していません。
メモ: Errors
オブジェクトはシングルスレッドです。
setNestedPath(java.lang.String)
, BindException
, DataBinder
, ValidationUtils
修飾子と型 | フィールドと説明 |
---|---|
static StringSE | NESTED_PATH_SEPARATOR ネストされたパス(たとえば、"customer.name" または "customer.address.street" )内のパス要素間の区切り文字。 |
修飾子と型 | メソッドと説明 |
---|---|
void | addAllErrors(Errors errors) 指定された Errors インスタンスからのすべてのエラーをこの Errors インスタンスに追加します。 |
ListSE<ObjectError> | getAllErrors() グローバルエラーとフィールドエラーの両方のすべてのエラーを取得します。 |
int | getErrorCount() エラーの総数を返します。 |
FieldError | getFieldError() フィールドに関連付けられている最初のエラーがあれば、それを取得します。 |
FieldError | getFieldError(StringSE field) 指定されたフィールドに関連付けられている最初のエラーがあれば、それを取得します。 |
int | getFieldErrorCount() フィールドに関連付けられているエラーの数を返します。 |
int | getFieldErrorCount(StringSE field) 指定されたフィールドに関連付けられているエラーの数を返します。 |
ListSE<FieldError> | getFieldErrors() フィールドに関連付けられているすべてのエラーを取得します。 |
ListSE<FieldError> | getFieldErrors(StringSE field) 指定されたフィールドに関連するすべてのエラーを取得します。 |
ClassSE<?> | getFieldType(StringSE field) 指定されたフィールドの型を返します。 |
ObjectSE | getFieldValue(StringSE field) 指定されたフィールドの現在の値、現在の Bean プロパティ値、最後のバインディングからの拒否された更新を返します。 |
ObjectError | getGlobalError() もしあれば、 最初のグローバルエラーを取得します。 |
int | getGlobalErrorCount() グローバルエラーの数を返します。 |
ListSE<ObjectError> | getGlobalErrors() すべてのグローバルエラーを取得します。 |
StringSE | getNestedPath() この Errors オブジェクトの現在のネストされたパスを返します。 |
StringSE | getObjectName() バインドされたルートオブジェクトの名前を返します。 |
boolean | hasErrors() エラーがあった場合に戻ります。 |
boolean | hasFieldErrors() フィールドエラーはありますか? |
boolean | hasFieldErrors(StringSE field) 特定のフィールドに関連するエラーはありますか? |
boolean | hasGlobalErrors() グローバルエラーはありますか? |
void | popNestedPath() ネストされたパススタックから以前のネストされたパスをポップします。 |
void | pushNestedPath(StringSE subPath) 指定されたサブパスをネストされたパススタックにプッシュします。 |
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 | setNestedPath(StringSE nestedPath) 標準バリデーターがサブツリーを検証できるように、コンテキストの変更を許可します。 |
static final StringSE NESTED_PATH_SEPARATOR
"" = Bean パッケージの nested property separator
と同じ。
StringSE getObjectName()
void setNestedPath(StringSE nestedPath)
例: 住所検証ツールは、顧客オブジェクトのサブオブジェクト「住所」を検証できます。
nestedPath
- このオブジェクト内のネストされたパス。「アドレス」(デフォルトは ""、null
も使用可能)。「アドレス」と「アドレス」の両方で終わることができます。有効です。StringSE getNestedPath()
Errors
オブジェクトの現在のネストされたパスを返します。連結されたパスを簡単に構築するために、ドット付きのネストされたパス、つまり「アドレス」を返します。デフォルトは空の文字列です。
void pushNestedPath(StringSE subPath)
popNestedPath()
呼び出しは、対応する pushNestedPath(String)
呼び出しの前に元のネストされたパスをリセットします。
ネストパススタックを使用すると、一時パスホルダーを気にすることなく、サブオブジェクトの一時ネストパスを設定できます。
次に例を示します: 現在のパス "spouse。"、pushNestedPath("child" )→ 結果パス "spouse.child。"; popNestedPath()→ " 配偶者。" また。
subPath
- ネストされたパススタックにプッシュするサブパス popNestedPath()
void popNestedPath() throws IllegalStateExceptionSE
IllegalStateExceptionSE
- スタックに元のネストされたパスがない場合 pushNestedPath(java.lang.String)
void reject(StringSE errorCode)
errorCode
- エラーコード、メッセージキーとして解釈可能 void reject(StringSE errorCode, StringSE defaultMessage)
errorCode
- エラーコード、メッセージキーとして解釈可能 defaultMessage
- フォールバックのデフォルトメッセージ void reject(StringSE errorCode, @Nullable ObjectSE[] errorArgs, @Nullable StringSE defaultMessage)
errorCode
- エラーコード、メッセージキーとして解釈可能 errorArgs
- エラー引数、MessageFormat を介した引数バインディング用 (null
にすることができます)defaultMessage
- フォールバックのデフォルトメッセージ void rejectValue(@Nullable StringSE field, StringSE errorCode)
フィールド名は null
または空の文字列で、フィールドではなく現在のオブジェクト自体を示します。これにより、ネストされたオブジェクトグラフ内で対応するフィールドエラーが発生するか、現在のオブジェクトが最上位オブジェクトである場合にグローバルエラーが発生する可能性があります。
field
- フィールド名 (null
または空の文字列です)errorCode
- エラーコード、メッセージキーとして解釈可能 getNestedPath()
void rejectValue(@Nullable StringSE field, StringSE errorCode, StringSE defaultMessage)
フィールド名は null
または空の文字列で、フィールドではなく現在のオブジェクト自体を示します。これにより、ネストされたオブジェクトグラフ内で対応するフィールドエラーが発生するか、現在のオブジェクトが最上位オブジェクトである場合にグローバルエラーが発生する可能性があります。
field
- フィールド名 (null
または空の文字列です)errorCode
- エラーコード、メッセージキーとして解釈可能 defaultMessage
- フォールバックのデフォルトメッセージ getNestedPath()
void rejectValue(@Nullable StringSE field, StringSE errorCode, @Nullable ObjectSE[] errorArgs, @Nullable StringSE defaultMessage)
フィールド名は null
または空の文字列で、フィールドではなく現在のオブジェクト自体を示します。これにより、ネストされたオブジェクトグラフ内で対応するフィールドエラーが発生するか、現在のオブジェクトが最上位オブジェクトである場合にグローバルエラーが発生する可能性があります。
field
- フィールド名 (null
または空の文字列です)errorCode
- エラーコード、メッセージキーとして解釈可能 errorArgs
- エラー引数、MessageFormat を介した引数バインディング用 (null
にすることができます)defaultMessage
- フォールバックのデフォルトメッセージ getNestedPath()
void addAllErrors(Errors errors)
Errors
インスタンスからのすべてのエラーをこの Errors
インスタンスに追加します。 これは、Errors
インスタンスを別の Errors
インスタンスにマージするために繰り返される reject(..)
呼び出しを避けるための便利なメソッドです。
渡された Errors
インスタンスは同じターゲットオブジェクトを参照するか、少なくともこの Errors
インスタンスのターゲットオブジェクトに適用される互換性のあるエラーを含むことに注意してください。
errors
- マージする Errors
インスタンス boolean hasErrors()
int getErrorCount()
ListSE<ObjectError> getAllErrors()
ObjectError
インスタンスのリスト boolean hasGlobalErrors()
true
hasFieldErrors()
int getGlobalErrorCount()
getFieldErrorCount()
ListSE<ObjectError> getGlobalErrors()
ObjectError
インスタンスのリスト @Nullable ObjectError getGlobalError()
null
boolean hasFieldErrors()
true
hasGlobalErrors()
int getFieldErrorCount()
getGlobalErrorCount()
ListSE<FieldError> getFieldErrors()
FieldError
インスタンスのリスト @Nullable FieldError getFieldError()
null
boolean hasFieldErrors(StringSE field)
field
- フィールド名 true
int getFieldErrorCount(StringSE field)
field
- フィールド名 ListSE<FieldError> getFieldErrors(StringSE field)
実装では、"name" などの完全なフィールド名だけでなく、"na *" や "address.*" などのパターン一致もサポートする必要があります。
field
- フィールド名 FieldError
インスタンスのリスト @Nullable FieldError getFieldError(StringSE field)
field
- フィールド名 null
@Nullable ObjectSE getFieldValue(StringSE field)
型の不一致があった場合でも、ユーザー指定のフィールド値に簡単にアクセスできます。
field
- フィールド名