Class FieldError

java.lang.Object

org.springframework.context.support.DefaultMessageSourceResolvable

org.springframework.validation.ObjectError

org.springframework.validation.FieldError

All Implemented Interfaces:

Serializable, MessageSourceResolvable

public class FieldError
extends ObjectError

Encapsulates a field error, that is, a reason for rejecting a specific field value.

See the DefaultMessageCodesResolver javadoc for details on how a message code list is built for a FieldError.

Since:

10.03.2003

Author:

Rod Johnson, Juergen Hoeller

See Also:

• DefaultMessageCodesResolver
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
FieldError(String objectName, String field, @Nullable Object rejectedValue, boolean bindingFailure, String @Nullable [] codes, Object @Nullable [] arguments, @Nullable String defaultMessage)	Create a new FieldError instance.
FieldError(String objectName, String field, String defaultMessage)	Create a new FieldError instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object other)
String	getField()	Return the affected field of the object.
@Nullable Object	getRejectedValue()	Return the rejected field value.
int	hashCode()
boolean	isBindingFailure()	Return whether this error represents a binding failure (like a type mismatch); otherwise it is a validation failure.
String	toString()	The default implementation exposes the attributes of this MessageSourceResolvable.

Methods inherited from class ObjectError

contains, getObjectName, unwrap, wrap

Methods inherited from class DefaultMessageSourceResolvable

getArguments, getCode, getCodes, getDefaultMessage, resolvableToString, shouldRenderDefaultMessage

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

FieldError

public FieldError(String objectName,
 String field,
 String defaultMessage)

Create a new FieldError instance.

Parameters:

objectName - the name of the affected object

field - the affected field of the object

defaultMessage - the default message to be used to resolve this message

FieldError

public FieldError(String objectName,
 String field,
 @Nullable Object rejectedValue,
 boolean bindingFailure,
 String @Nullable [] codes,
 Object @Nullable [] arguments,
 @Nullable String defaultMessage)

Create a new FieldError instance.

Parameters:

objectName - the name of the affected object

field - the affected field of the object

rejectedValue - the rejected field value

bindingFailure - whether this error represents a binding failure (like a type mismatch); else, it is a validation failure

codes - the codes to be used to resolve this message

arguments - the array of arguments to be used to resolve this message

defaultMessage - the default message to be used to resolve this message

Method Details

getField

public String getField()

Return the affected field of the object.

getRejectedValue

public @Nullable Object getRejectedValue()

Return the rejected field value.

isBindingFailure

public boolean isBindingFailure()

Return whether this error represents a binding failure (like a type mismatch); otherwise it is a validation failure.

equals

public boolean equals(@Nullable Object other)

Overrides:

equals in class ObjectError

hashCode

public int hashCode()

Overrides:

hashCode in class ObjectError

toString

public String toString()

Description copied from class: DefaultMessageSourceResolvable

The default implementation exposes the attributes of this MessageSourceResolvable.

To be overridden in more specific subclasses, potentially including the resolvable content through resolvableToString().

Overrides:

toString in class ObjectError

See Also:

• DefaultMessageSourceResolvable.resolvableToString()