Top Description Fields Constructors Methods
org.springframework.validation

public Class FieldError

extends ObjectError
Class Inheritance
Known Direct Subclasses
org.springframework.validation.beanvalidation.SpringValidatorAdapter.ViolationFieldError
Annotations
@SuppressWarnings:serial
Imports
org.springframework.lang.Nullable, org.springframework.util.Assert, .ObjectUtils
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.

Authors
Rod Johnson, Juergen Hoeller
Since
10.03.2003
See Also
DefaultMessageCodesResolver

Field Summary

Modifier and TypeField and Description
private final boolean
bindingFailure

private final String
field

private final Object
rejectedValue

Constructor Summary

AccessConstructor and Description
public
FieldError(String
the name of the affected object
objectName, String
the affected field of the object
field, String
the default message to be used to resolve this message
defaultMessage)

Create a new FieldError instance.

public
FieldError(String
the name of the affected object
objectName, String
the affected field of the object
field, Object
the rejected field value
rejectedValue, boolean
whether this error represents a binding failure (like a type mismatch); else, it is a validation failure
bindingFailure, String[]
the codes to be used to resolve this message
codes, Object[]
the array of arguments to be used to resolve this message
arguments, String
the default message to be used to resolve this message
defaultMessage)

Create a new FieldError instance.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
other)

Overrides org.springframework.validation.ObjectError.equals.

Indicates whether some other object is "equal to" this one.
public String
getField()

Return the affected field of the object.

public Object
getRejectedValue()

Return the rejected field value.

public int
hashCode()

Overrides org.springframework.validation.ObjectError.hashCode.

Returns a hash code value for the object.
public boolean
isBindingFailure()

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

public String
toString()

Overrides org.springframework.validation.ObjectError.toString.

The default implementation exposes the attributes of this MessageSourceResolvable.
Inherited from org.springframework.validation.ObjectError:
containsgetObjectNameunwrapwrap

Field Detail

bindingFailureback to summary
private final boolean bindingFailure
fieldback to summary
private final String field
rejectedValueback to summary
private final Object rejectedValue
Annotations
@Nullable

Constructor Detail

FieldErrorback to summary
public FieldError(String objectName, String field, String defaultMessage)

Create a new FieldError instance.

Parameters
objectName:String

the name of the affected object

field:String

the affected field of the object

defaultMessage:String

the default message to be used to resolve this message

FieldErrorback to summary
public FieldError(String objectName, String field, Object rejectedValue, boolean bindingFailure, String[] codes, Object[] arguments, String defaultMessage)

Create a new FieldError instance.

Parameters
objectName:String

the name of the affected object

field:String

the affected field of the object

rejectedValue:Object

the rejected field value

bindingFailure:boolean

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

codes:String[]

the codes to be used to resolve this message

arguments:Object[]

the array of arguments to be used to resolve this message

defaultMessage:String

the default message to be used to resolve this message

Method Detail

equalsback to summary
public boolean equals(Object other)

Overrides org.springframework.validation.ObjectError.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getFieldback to summary
public String getField()

Return the affected field of the object.

getRejectedValueback to summary
public Object getRejectedValue()

Return the rejected field value.

Annotations
@Nullable
hashCodeback to summary
public int hashCode()

Overrides org.springframework.validation.ObjectError.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
isBindingFailureback to summary
public boolean isBindingFailure()

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

toStringback to summary
public String toString()

Overrides org.springframework.validation.ObjectError.toString.

Doc from org.springframework.context.support.DefaultMessageSourceResolvable.toString.

The default implementation exposes the attributes of this MessageSourceResolvable.

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

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations
@Override