类 EscapedErrors
- java.lang.Object
- org.springframework.web.bind.EscapedErrors
- 所有已实现的接口:
Errors
public class EscapedErrors extends Object implements Errors
Errors wrapper that adds automatic HTML escaping to the wrapped instance, for convenient usage in HTML views. Can be retrieved easily via RequestContext'sgetErrors
method.Note that BindTag does not use this class to avoid unnecessary creation of ObjectError instances. It just escapes the messages and values that get copied into the respective BindStatus instance.
- 从以下版本开始:
- 01.03.2003
- 作者:
- Juergen Hoeller
- 另请参阅:
RequestContext.getErrors(java.lang.String)
,BindTag
字段概要
从接口继承的字段 org.springframework.validation.Errors
NESTED_PATH_SEPARATOR
构造器概要
构造器 构造器 说明 EscapedErrors(Errors source)
Create a new EscapedErrors instance for the given source instance.
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 void
addAllErrors(Errors errors)
Add all errors from the givenErrors
instance to thisErrors
instance.List<ObjectError>
getAllErrors()
Get all errors, both global and field ones.int
getErrorCount()
Return the total number of errors.FieldError
getFieldError()
Get the first error associated with a field, if any.FieldError
getFieldError(String field)
Get the first error associated with the given field, if any.int
getFieldErrorCount()
Return the number of errors associated with a field.int
getFieldErrorCount(String field)
Return the number of errors associated with the given field.List<FieldError>
getFieldErrors()
Get all errors associated with a field.List<FieldError>
getFieldErrors(String field)
Get all errors associated with the given field.Class<?>
getFieldType(String field)
Return the type of a given field.Object
getFieldValue(String field)
Return the current value of the given field, either the current bean property value or a rejected update from the last binding.ObjectError
getGlobalError()
Get the first global error, if any.int
getGlobalErrorCount()
Return the number of global errors.List<ObjectError>
getGlobalErrors()
Get all global errors.String
getNestedPath()
Return the current nested path of thisErrors
object.String
getObjectName()
Return the name of the bound root object.Errors
getSource()
boolean
hasErrors()
Return if there were any errors.boolean
hasFieldErrors()
Are there any field errors?boolean
hasFieldErrors(String field)
Are there any errors associated with the given field?boolean
hasGlobalErrors()
Are there any global errors?void
popNestedPath()
Pop the former nested path from the nested path stack.void
pushNestedPath(String subPath)
Push the given sub path onto the nested path stack.void
reject(String errorCode)
Register a global error for the entire target object, using the given error description.void
reject(String errorCode, Object[] errorArgs, String defaultMessage)
Register a global error for the entire target object, using the given error description.void
reject(String errorCode, String defaultMessage)
Register a global error for the entire target object, using the given error description.void
rejectValue(String field, String errorCode)
Register a field error for the specified field of the current object (respecting the current nested path, if any), using the given error description.void
rejectValue(String field, String errorCode, Object[] errorArgs, String defaultMessage)
Register a field error for the specified field of the current object (respecting the current nested path, if any), using the given error description.void
rejectValue(String field, String errorCode, String defaultMessage)
Register a field error for the specified field of the current object (respecting the current nested path, if any), using the given error description.void
setNestedPath(String nestedPath)
Allow context to be changed so that standard validators can validate subtrees.
构造器详细资料
EscapedErrors
public EscapedErrors(Errors source)
Create a new EscapedErrors instance for the given source instance.
方法详细资料
getObjectName
public String getObjectName()
从接口复制的说明:Errors
Return the name of the bound root object.- 指定者:
getObjectName
在接口中Errors
setNestedPath
public void setNestedPath(String nestedPath)
从接口复制的说明:Errors
Allow context to be changed so that standard validators can validate subtrees. Reject calls prepend the given path to the field names.For example, an address validator could validate the subobject "address" of a customer object.
- 指定者:
setNestedPath
在接口中Errors
- 参数:
nestedPath
- nested path within this object, e.g. "address" (defaults to "",null
is also acceptable). Can end with a dot: both "address" and "address." are valid.
getNestedPath
public String getNestedPath()
从接口复制的说明:Errors
Return the current nested path of thisErrors
object.Returns a nested path with a dot, i.e. "address.", for easy building of concatenated paths. Default is an empty String.
- 指定者:
getNestedPath
在接口中Errors
pushNestedPath
public void pushNestedPath(String subPath)
从接口复制的说明:Errors
Push the given sub path onto the nested path stack.A
Errors.popNestedPath()
call will reset the original nested path before the correspondingpushNestedPath(String)
call.Using the nested path stack allows to set temporary nested paths for subobjects without having to worry about a temporary path holder.
For example: current path "spouse.", pushNestedPath("child") -> result path "spouse.child."; popNestedPath() -> "spouse." again.
- 指定者:
pushNestedPath
在接口中Errors
- 参数:
subPath
- the sub path to push onto the nested path stack- 另请参阅:
Errors.popNestedPath()
popNestedPath
public void popNestedPath() throws IllegalStateException
从接口复制的说明:Errors
Pop the former nested path from the nested path stack.- 指定者:
popNestedPath
在接口中Errors
- 抛出:
IllegalStateException
- if there is no former nested path on the stack- 另请参阅:
Errors.pushNestedPath(java.lang.String)
reject
public void reject(String errorCode)
从接口复制的说明:Errors
Register a global error for the entire target object, using the given error description.
reject
public void reject(String errorCode, String defaultMessage)
从接口复制的说明:Errors
Register a global error for the entire target object, using the given error description.
reject
public void reject(String errorCode, @Nullable Object[] errorArgs, @Nullable String defaultMessage)
从接口复制的说明:Errors
Register a global error for the entire target object, using the given error description.
rejectValue
public void rejectValue(@Nullable String field, String errorCode)
从接口复制的说明:Errors
Register a field error for the specified field of the current object (respecting the current nested path, if any), using the given error description.The field name may be
null
or empty String to indicate the current object itself rather than a field of it. This may result in a corresponding field error within the nested object graph or a global error if the current object is the top object.- 指定者:
rejectValue
在接口中Errors
- 参数:
field
- the field name (may benull
or empty String)errorCode
- error code, interpretable as a message key- 另请参阅:
Errors.getNestedPath()
rejectValue
public void rejectValue(@Nullable String field, String errorCode, String defaultMessage)
从接口复制的说明:Errors
Register a field error for the specified field of the current object (respecting the current nested path, if any), using the given error description.The field name may be
null
or empty String to indicate the current object itself rather than a field of it. This may result in a corresponding field error within the nested object graph or a global error if the current object is the top object.- 指定者:
rejectValue
在接口中Errors
- 参数:
field
- the field name (may benull
or empty String)errorCode
- error code, interpretable as a message keydefaultMessage
- fallback default message- 另请参阅:
Errors.getNestedPath()
rejectValue
public void rejectValue(@Nullable String field, String errorCode, @Nullable Object[] errorArgs, @Nullable String defaultMessage)
从接口复制的说明:Errors
Register a field error for the specified field of the current object (respecting the current nested path, if any), using the given error description.The field name may be
null
or empty String to indicate the current object itself rather than a field of it. This may result in a corresponding field error within the nested object graph or a global error if the current object is the top object.- 指定者:
rejectValue
在接口中Errors
- 参数:
field
- the field name (may benull
or empty String)errorCode
- error code, interpretable as a message keyerrorArgs
- error arguments, for argument binding via MessageFormat (can benull
)defaultMessage
- fallback default message- 另请参阅:
Errors.getNestedPath()
addAllErrors
public void addAllErrors(Errors errors)
从接口复制的说明:Errors
Add all errors from the givenErrors
instance to thisErrors
instance.This is a convenience method to avoid repeated
reject(..)
calls for merging anErrors
instance into anotherErrors
instance.Note that the passed-in
Errors
instance is supposed to refer to the same target object, or at least contain compatible errors that apply to the target object of thisErrors
instance.- 指定者:
addAllErrors
在接口中Errors
- 参数:
errors
- theErrors
instance to merge in
getErrorCount
public int getErrorCount()
从接口复制的说明:Errors
Return the total number of errors.- 指定者:
getErrorCount
在接口中Errors
getAllErrors
public List<ObjectError> getAllErrors()
从接口复制的说明:Errors
Get all errors, both global and field ones.- 指定者:
getAllErrors
在接口中Errors
- 返回:
- a list of
ObjectError
instances
hasGlobalErrors
public boolean hasGlobalErrors()
从接口复制的说明:Errors
Are there any global errors?- 指定者:
hasGlobalErrors
在接口中Errors
- 返回:
true
if there are any global errors- 另请参阅:
Errors.hasFieldErrors()
getGlobalErrorCount
public int getGlobalErrorCount()
从接口复制的说明:Errors
Return the number of global errors.- 指定者:
getGlobalErrorCount
在接口中Errors
- 返回:
- the number of global errors
- 另请参阅:
Errors.getFieldErrorCount()
getGlobalErrors
public List<ObjectError> getGlobalErrors()
从接口复制的说明:Errors
Get all global errors.- 指定者:
getGlobalErrors
在接口中Errors
- 返回:
- a list of
ObjectError
instances
getGlobalError
@Nullable public ObjectError getGlobalError()
从接口复制的说明:Errors
Get the first global error, if any.- 指定者:
getGlobalError
在接口中Errors
- 返回:
- the global error, or
null
hasFieldErrors
public boolean hasFieldErrors()
从接口复制的说明:Errors
Are there any field errors?- 指定者:
hasFieldErrors
在接口中Errors
- 返回:
true
if there are any errors associated with a field- 另请参阅:
Errors.hasGlobalErrors()
getFieldErrorCount
public int getFieldErrorCount()
从接口复制的说明:Errors
Return the number of errors associated with a field.- 指定者:
getFieldErrorCount
在接口中Errors
- 返回:
- the number of errors associated with a field
- 另请参阅:
Errors.getGlobalErrorCount()
getFieldErrors
public List<FieldError> getFieldErrors()
从接口复制的说明:Errors
Get all errors associated with a field.- 指定者:
getFieldErrors
在接口中Errors
- 返回:
- a List of
FieldError
instances
getFieldError
@Nullable public FieldError getFieldError()
从接口复制的说明:Errors
Get the first error associated with a field, if any.- 指定者:
getFieldError
在接口中Errors
- 返回:
- the field-specific error, or
null
hasFieldErrors
public boolean hasFieldErrors(String field)
从接口复制的说明:Errors
Are there any errors associated with the given field?- 指定者:
hasFieldErrors
在接口中Errors
- 参数:
field
- the field name- 返回:
true
if there were any errors associated with the given field
getFieldErrorCount
public int getFieldErrorCount(String field)
从接口复制的说明:Errors
Return the number of errors associated with the given field.- 指定者:
getFieldErrorCount
在接口中Errors
- 参数:
field
- the field name- 返回:
- the number of errors associated with the given field
getFieldErrors
public List<FieldError> getFieldErrors(String field)
从接口复制的说明:Errors
Get all errors associated with the given field.Implementations should support not only full field names like "name" but also pattern matches like "na*" or "address.*".
- 指定者:
getFieldErrors
在接口中Errors
- 参数:
field
- the field name- 返回:
- a List of
FieldError
instances
getFieldError
@Nullable public FieldError getFieldError(String field)
从接口复制的说明:Errors
Get the first error associated with the given field, if any.- 指定者:
getFieldError
在接口中Errors
- 参数:
field
- the field name- 返回:
- the field-specific error, or
null
getFieldValue
@Nullable public Object getFieldValue(String field)
从接口复制的说明:Errors
Return the current value of the given field, either the current bean property value or a rejected update from the last binding.Allows for convenient access to user-specified field values, even if there were type mismatches.
- 指定者:
getFieldValue
在接口中Errors
- 参数:
field
- the field name- 返回:
- the current value of the given field
getFieldType
@Nullable public Class<?> getFieldType(String field)
从接口复制的说明:Errors
Return the type of a given field.Implementations should be able to determine the type even when the field value is
null
, for example from some associated descriptor.- 指定者:
getFieldType
在接口中Errors
- 参数:
field
- the field name- 返回:
- the type of the field, or
null
if not determinable