Spring Framework 6.1.4 · org.springframework.validation.ObjectError

Modifier and Type	Field and Description
private final String	objectName
private transient Object	source

Access	Constructor and Description
public	ObjectError(String the name of the affected object objectName, String the default message to be used to resolve this message defaultMessage) Create a new instance of the ObjectError class.
public	ObjectError(String the name of the affected object objectName, 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 instance of the ObjectError class.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: whether this error has been caused by a source object of the given type contains(Class<?> sourceType) Check the source behind this error: possibly an `Exception` (typically `org.springframework.beans.PropertyAccessException`) or a Bean Validation `jakarta.validation.ConstraintViolation`.
public boolean	equals(Object the reference object with which to compare. other) Overrides org.springframework.context.support.DefaultMessageSourceResolvable.equals. Indicates whether some other object is "equal to" this one.
public String	getObjectName() Return the name of the affected object.
public int	hashCode() Overrides org.springframework.context.support.DefaultMessageSourceResolvable.hashCode. Returns a hash code value for this object.
public String	toString() Overrides org.springframework.context.support.DefaultMessageSourceResolvable.toString. The default implementation exposes the attributes of this MessageSourceResolvable.
public <T> T	Returns: the source object of the given type unwrap(Class<T> sourceType) Unwrap the source behind this error: possibly an `Exception` (typically `org.springframework.beans.PropertyAccessException`) or a Bean Validation `jakarta.validation.ConstraintViolation`.
public void	wrap(Object the source object source) Preserve the source behind this error: possibly an `Exception` (typically `org.springframework.beans.PropertyAccessException`) or a Bean Validation `jakarta.validation.ConstraintViolation`.

Inherited from org.springframework.context.support.DefaultMessageSourceResolvable:: getArguments getCode getCodes getDefaultMessage resolvableToString shouldRenderDefaultMessage

objectName	back to summary
private final String objectName

source	back to summary
private transient Object source Annotations @Nullable

ObjectError	back to summary
public ObjectError(String objectName, String defaultMessage) Create a new instance of the ObjectError class. Parameters objectName:String the name of the affected object defaultMessage:String the default message to be used to resolve this message

ObjectError	back to summary
public ObjectError(String objectName, String[] codes, Object[] arguments, String defaultMessage) Create a new instance of the ObjectError class. Parameters objectName:String the name of the affected object 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

contains back to summary

contains	back to summary
public boolean contains(Class<?> sourceType) Check the source behind this error: possibly an `Exception` (typically `org.springframework.beans.PropertyAccessException`) or a Bean Validation `jakarta.validation.ConstraintViolation`. The cause of the outermost exception will be introspected as well, e.g. the underlying conversion exception or exception thrown from a setter (instead of having to unwrap the `PropertyAccessException` in turn). Returns:boolean whether this error has been caused by a source object of the given type Since 5.0.4

public boolean contains(Class<?> sourceType)

Check the source behind this error: possibly an Exception (typically org.springframework.beans.PropertyAccessException) or a Bean Validation jakarta.validation.ConstraintViolation.

The cause of the outermost exception will be introspected as well, e.g. the underlying conversion exception or exception thrown from a setter (instead of having to unwrap the PropertyAccessException in turn).

Returns:boolean: whether this error has been caused by a source object of the given type
Since: 5.0.4

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides org.springframework.context.support.DefaultMessageSourceResolvable.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

public boolean equals(Object other)

Overrides org.springframework.context.support.DefaultMessageSourceResolvable.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

getObjectName	back to summary
public String getObjectName() Return the name of the affected object.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides org.springframework.context.support.DefaultMessageSourceResolvable.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this 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

public int hashCode()

Overrides org.springframework.context.support.DefaultMessageSourceResolvable.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this 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

toString back to summary

toString	back to summary
public String toString() Overrides org.springframework.context.support.DefaultMessageSourceResolvable.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

public String toString()

Overrides org.springframework.context.support.DefaultMessageSourceResolvable.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

unwrap back to summary

unwrap	back to summary
public <T> T unwrap(Class<T> sourceType) Unwrap the source behind this error: possibly an `Exception` (typically `org.springframework.beans.PropertyAccessException`) or a Bean Validation `jakarta.validation.ConstraintViolation`. The cause of the outermost exception will be introspected as well, e.g. the underlying conversion exception or exception thrown from a setter (instead of having to unwrap the `PropertyAccessException` in turn). Returns:T the source object of the given type Exceptions IllegalArgumentException: if no such source object is available (i.e. none specified or not available anymore after deserialization) Since 5.0.4

public <T> T unwrap(Class<T> sourceType)

Unwrap the source behind this error: possibly an Exception (typically org.springframework.beans.PropertyAccessException) or a Bean Validation jakarta.validation.ConstraintViolation.

Returns:T

the source object of the given type

Exceptions

IllegalArgumentException:: if no such source object is available (i.e. none specified or not available anymore after deserialization)

Since

5.0.4

wrap back to summary

wrap	back to summary
public void wrap(Object source) Preserve the source behind this error: possibly an `Exception` (typically `org.springframework.beans.PropertyAccessException`) or a Bean Validation `jakarta.validation.ConstraintViolation`. Note that any such source object is being stored as transient: that is, it won't be part of a serialized error representation. Parameters source:Object the source object Since 5.0.4

public void wrap(Object source)

Preserve the source behind this error: possibly an Exception (typically org.springframework.beans.PropertyAccessException) or a Bean Validation jakarta.validation.ConstraintViolation.

Note that any such source object is being stored as transient: that is, it won't be part of a serialized error representation.

Parameters

source:Object: the source object

Since

5.0.4

public Class ObjectError

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail