类 BindStatus
- java.lang.Object
- org.springframework.web.reactive.result.view.BindStatus
public class BindStatus extends Object
Simple adapter to expose the bind status of a field or object. Set as a variable by FreeMarker macros and other tag libraries.Obviously, object status representations (i.e. errors at the object level rather than the field level) do not have an expression and a value but only error codes and messages. For simplicity's sake and to be able to use the same tags and macros, the same status class is used for both scenarios.
- 从以下版本开始:
- 5.0
- 作者:
- Rossen Stoyanchev, Juergen Hoeller
- 另请参阅:
RequestContext.getBindStatus(java.lang.String)
构造器概要
构造器 构造器 说明 BindStatus(RequestContext requestContext, String path, boolean htmlEscape)
Create a new BindStatus instance, representing a field or object status.
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 PropertyEditor
findEditor(Class<?> valueClass)
Find a PropertyEditor for the given value class, associated with the property that this bound status is currently bound to.Object
getActualValue()
Return the actual value of the field, i.e. the raw property value, ornull
if not available.String
getDisplayValue()
Return a suitable display value for the field, i.e. the stringified value if not null, and an empty string in case of a null value.PropertyEditor
getEditor()
Return the PropertyEditor for the property that this bind status is currently bound to.String
getErrorCode()
Return the first error codes for the field or object, if any.String[]
getErrorCodes()
Return the error codes for the field or object, if any.String
getErrorMessage()
Return the first error message for the field or object, if any.String[]
getErrorMessages()
Return the resolved error messages for the field or object, if any.String
getErrorMessagesAsString(String delimiter)
Return an error message string, concatenating all messages separated by the given delimiter.Errors
getErrors()
Return the Errors instance (typically a BindingResult) that this bind status is currently associated with.String
getExpression()
Return a bind expression that can be used in HTML forms as input name for the respective field, ornull
if not field-specific.String
getPath()
Return the bean and property path for which values and errors will be resolved (e.g.Object
getValue()
Return the current value of the field, i.e. either the property value or a rejected update, ornull
if not field-specific.Class<?>
getValueType()
Get the 'Class
' type of the field.boolean
isError()
Return if this status represents a field or object error.String
toString()
构造器详细资料
BindStatus
public BindStatus(RequestContext requestContext, String path, boolean htmlEscape) throws IllegalStateException
Create a new BindStatus instance, representing a field or object status.- 参数:
requestContext
- the current RequestContextpath
- the bean and property path for which values and errors will be resolved (e.g. "customer.address.street")htmlEscape
- whether to HTML-escape error messages and string values- 抛出:
IllegalStateException
- if no corresponding Errors object found
方法详细资料
getPath
public String getPath()
Return the bean and property path for which values and errors will be resolved (e.g. "customer.address.street").
getExpression
@Nullable public String getExpression()
Return a bind expression that can be used in HTML forms as input name for the respective field, ornull
if not field-specific.Returns a bind path appropriate for resubmission, e.g. "address.street". Note that the complete bind path as required by the bind tag is "customer.address.street", if bound to a "customer" bean.
getValue
@Nullable public Object getValue()
Return the current value of the field, i.e. either the property value or a rejected update, ornull
if not field-specific.This value will be an HTML-escaped String if the original value already was a String.
getValueType
@Nullable public Class<?> getValueType()
Get the 'Class
' type of the field. Favor this instead of 'getValue().getClass()
' since 'getValue()
' may return 'null
'.
getActualValue
@Nullable public Object getActualValue()
Return the actual value of the field, i.e. the raw property value, ornull
if not available.
getDisplayValue
public String getDisplayValue()
Return a suitable display value for the field, i.e. the stringified value if not null, and an empty string in case of a null value.This value will be an HTML-escaped String if the original value was non-null: the
toString
result of the original value will get HTML-escaped.
isError
public boolean isError()
Return if this status represents a field or object error.
getErrorCodes
public String[] getErrorCodes()
Return the error codes for the field or object, if any. Returns an empty array instead of null if none.
getErrorCode
public String getErrorCode()
Return the first error codes for the field or object, if any.
getErrorMessages
public String[] getErrorMessages()
Return the resolved error messages for the field or object, if any. Returns an empty array instead of null if none.
getErrorMessage
public String getErrorMessage()
Return the first error message for the field or object, if any.
getErrorMessagesAsString
public String getErrorMessagesAsString(String delimiter)
Return an error message string, concatenating all messages separated by the given delimiter.- 参数:
delimiter
- separator string, e.g. ", " or "
"- 返回:
- the error message string
getErrors
@Nullable public Errors getErrors()
Return the Errors instance (typically a BindingResult) that this bind status is currently associated with.- 返回:
- the current Errors instance, or
null
if none - 另请参阅:
BindingResult
getEditor
@Nullable public PropertyEditor getEditor()
Return the PropertyEditor for the property that this bind status is currently bound to.- 返回:
- the current PropertyEditor, or
null
if none
findEditor
@Nullable public PropertyEditor findEditor(Class<?> valueClass)
Find a PropertyEditor for the given value class, associated with the property that this bound status is currently bound to.- 参数:
valueClass
- the value class that an editor is needed for- 返回:
- the associated PropertyEditor, or
null
if none