Spring Framework 6.1.4 · org.springframework.web.servlet.support.BindStatus

Field Summary

Modifier and Type	Field and Description
private Object	actualValue
private BindingResult	bindingResult
private PropertyEditor	editor
private final String[]	errorCodes
private String[]	errorMessages
private final Errors	errors
private final String	expression
private final boolean	htmlEscape
private List<? extends ObjectError>	objectErrors
private final String	path
private final RequestContext	requestContext
private Object	value
private Class<?>	valueType

Constructor Summary

Access	Constructor and Description
public	BindStatus(RequestContext the current RequestContext requestContext, String the bean and property path for which values and errors will be resolved (e.g. "customer.address.street") path, boolean whether to HTML-escape error messages and string values htmlEscape) Create a new BindStatus instance, representing a field or object status.

Method Summary

Modifier and Type	Method and Description
public PropertyEditor	Returns: the associated PropertyEditor, or `null` if none findEditor(Class<?> the value class that an editor is needed for valueClass) Find a PropertyEditor for the given value class, associated with the property that this bound status is currently bound to.
public Object	getActualValue() Return the actual value of the field, i.e. the raw property value, or `null` if not available.
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.
public PropertyEditor	Returns: the current PropertyEditor, or `null` if none getEditor() Return the PropertyEditor for the property that this bind status is currently bound to.
public String	getErrorCode() Return the first error codes for the field or object, if any.
public String[]	getErrorCodes() Return the error codes for the field or object, if any.
public String	getErrorMessage() Return the first error message for the field or object, if any.
public String[]	getErrorMessages() Return the resolved error messages for the field or object, if any.
public String	Returns: the error message string getErrorMessagesAsString(String separator string, e.g. ", " or " " delimiter) Return an error message string, concatenating all messages separated by the given delimiter.
public Errors	Returns: the current Errors instance, or `null` if none getErrors() Return the Errors instance (typically a BindingResult) that this bind status is currently associated with.
public String	getExpression() Return a bind expression that can be used in HTML forms as input name for the respective field, or `null` if not field-specific.
public String	getPath() Return the bean and property path for which values and errors will be resolved (e.g. "customer.address.street").
public Object	getValue() Return the current value of the field, i.e. either the property value or a rejected update, or `null` if not field-specific.
public Class<?>	getValueType() Get the '`Class`' type of the field.
private static String[]	initErrorCodes(List<? extends ObjectError> objectErrors) Extract the error codes from the ObjectError list.
private String[]	initErrorMessages() Extract the error messages from the ObjectError list.
public boolean	isError() Return if this status represents a field or object error.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

actualValue	back to summary
private Object actualValue Annotations @Nullable

bindingResult	back to summary
private BindingResult bindingResult Annotations @Nullable

editor	back to summary
private PropertyEditor editor Annotations @Nullable

errorCodes	back to summary
private final String[] errorCodes

errorMessages	back to summary
private String[] errorMessages Annotations @Nullable

errors	back to summary
private final Errors errors Annotations @Nullable

expression	back to summary
private final String expression Annotations @Nullable

htmlEscape	back to summary
private final boolean htmlEscape

objectErrors	back to summary
private List<? extends ObjectError> objectErrors Annotations @Nullable

path	back to summary
private final String path

requestContext	back to summary
private final RequestContext requestContext

value	back to summary
private Object value Annotations @Nullable

valueType	back to summary
private Class<?> valueType Annotations @Nullable

Constructor Detail

BindStatus	back to summary
public BindStatus(RequestContext requestContext, String path, boolean htmlEscape) throws IllegalStateException Create a new BindStatus instance, representing a field or object status. Parameters requestContext:RequestContext the current RequestContext path:String the bean and property path for which values and errors will be resolved (e.g. "customer.address.street") htmlEscape:boolean whether to HTML-escape error messages and string values Exceptions IllegalStateException: if no corresponding Errors object found

BindStatus

back to summary

public BindStatus(RequestContext requestContext, String path, boolean htmlEscape) throws IllegalStateException

Create a new BindStatus instance, representing a field or object status.

Parameters

requestContext:RequestContext: the current RequestContext
path:String: the bean and property path for which values and errors will be resolved (e.g. "customer.address.street")
htmlEscape:boolean: whether to HTML-escape error messages and string values

Exceptions

IllegalStateException:: if no corresponding Errors object found

Method Detail

findEditor back to summary

findEditor	back to summary
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. Parameters valueClass:Class<?> the value class that an editor is needed for Returns:PropertyEditor the associated PropertyEditor, or `null` if none Annotations @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.

Parameters

valueClass:Class<?>: the value class that an editor is needed for

Returns:PropertyEditor

the associated PropertyEditor, or null if none

Annotations

@Nullable

getActualValue back to summary

getActualValue	back to summary
public Object getActualValue() Return the actual value of the field, i.e. the raw property value, or `null` if not available. Annotations @Nullable

public Object getActualValue()

Return the actual value of the field, i.e. the raw property value, or null if not available.

Annotations

@Nullable

getDisplayValue back to summary

getDisplayValue	back to summary
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.

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.

getEditor back to summary

getEditor	back to summary
public PropertyEditor getEditor() Return the PropertyEditor for the property that this bind status is currently bound to. Returns:PropertyEditor the current PropertyEditor, or `null` if none Annotations @Nullable

public PropertyEditor getEditor()

Return the PropertyEditor for the property that this bind status is currently bound to.

Returns:PropertyEditor

the current PropertyEditor, or null if none

Annotations

@Nullable

getErrorCode	back to summary
public String getErrorCode() Return the first error codes for the field or object, if any.

getErrorCodes	back to summary
public String[] getErrorCodes() Return the error codes for the field or object, if any. Returns an empty array instead of null if none.

getErrorMessage	back to summary
public String getErrorMessage() Return the first error message for the field or object, if any.

getErrorMessages	back to summary
public String[] getErrorMessages() Return the resolved error messages for the field or object, if any. Returns an empty array instead of null if none.

getErrorMessagesAsString	back to summary
public String getErrorMessagesAsString(String delimiter) Return an error message string, concatenating all messages separated by the given delimiter. Parameters delimiter:String separator string, e.g. ", " or " " Returns:String the error message string

getErrorMessagesAsString

back to summary

public String getErrorMessagesAsString(String delimiter)

Return an error message string, concatenating all messages separated by the given delimiter.

Parameters

delimiter:String: separator string, e.g. ", " or "
"

Returns:String

the error message string

getErrors back to summary

getErrors	back to summary
public Errors getErrors() Return the Errors instance (typically a BindingResult) that this bind status is currently associated with. Returns:Errors the current Errors instance, or `null` if none Annotations @Nullable See Also `org.springframework.validation.BindingResult`

public Errors getErrors()

Return the Errors instance (typically a BindingResult) that this bind status is currently associated with.

Returns:Errors

the current Errors instance, or null if none

Annotations

@Nullable

getExpression back to summary

getExpression	back to summary
public String getExpression() Return a bind expression that can be used in HTML forms as input name for the respective field, or `null` 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. Annotations @Nullable

public String getExpression()

Return a bind expression that can be used in HTML forms as input name for the respective field, or null 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.

Annotations

@Nullable

getPath	back to summary
public String getPath() Return the bean and property path for which values and errors will be resolved (e.g. "customer.address.street").

getValue back to summary

getValue	back to summary
public Object getValue() Return the current value of the field, i.e. either the property value or a rejected update, or `null` if not field-specific. This value will be an HTML-escaped String if the original value already was a String. Annotations @Nullable

public Object getValue()

Return the current value of the field, i.e. either the property value or a rejected update, or null if not field-specific.

This value will be an HTML-escaped String if the original value already was a String.

Annotations

@Nullable

getValueType back to summary

getValueType	back to summary
public Class<?> getValueType() Get the '`Class`' type of the field. Favor this instead of '`getValue().getClass()`' since '`getValue()`' may return '`null`'. Annotations @Nullable

public Class<?> getValueType()

Get the 'Class' type of the field. Favor this instead of 'getValue().getClass()' since 'getValue()' may return 'null'.

Annotations

@Nullable

initErrorCodes	back to summary
private static String[] initErrorCodes(List<? extends ObjectError> objectErrors) Extract the error codes from the ObjectError list.

initErrorMessages	back to summary
private String[] initErrorMessages() throws NoSuchMessageException Extract the error messages from the ObjectError list.

isError	back to summary
public boolean isError() Return if this status represents a field or object error.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class BindStatus

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail