Package org.springframework.boot.web.error

Class Error

java.lang.Object

org.springframework.boot.web.error.Error

All Implemented Interfaces:

MessageSourceResolvable

public final class Error
extends Object
implements MessageSourceResolvable

A wrapper class for MessageSourceResolvable errors that is safe for JSON serialization.

Since:

3.5.0

Author:

Yongjun Hong, Phillip Webb

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Object[]	getArguments()
MessageSourceResolvable	getCause()	Return the original cause of the error.
String[]	getCodes()
String	getDefaultMessage()
int	hashCode()
String	toString()
static List<Error>	wrap(List<? extends MessageSourceResolvable> errors)	Deprecated, for removal: This API element is subject to removal in a future version. since 3.5.4 for removal in 4.0.0 in favor of wrapIfNecessary(List)
static List<MessageSourceResolvable>	wrapIfNecessary(List<? extends MessageSourceResolvable> errors)	Wrap the given errors, if necessary, such that they are suitable for serialization to JSON.

Methods inherited from class java.lang.Object

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

Method Details

getCodes

public String[] getCodes()

Specified by:

getCodes in interface MessageSourceResolvable

getArguments

public Object[] getArguments()

Specified by:

getArguments in interface MessageSourceResolvable

getDefaultMessage

public String getDefaultMessage()

Specified by:

getDefaultMessage in interface MessageSourceResolvable

getCause

public MessageSourceResolvable getCause()

Return the original cause of the error.

Returns:

the error cause

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

wrap

@Deprecated(since="3.5.4",
            forRemoval=true)
public static List<Error> wrap(List<? extends MessageSourceResolvable> errors)

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.5.4 for removal in 4.0.0 in favor of wrapIfNecessary(List)

Wrap the given errors such that they are suitable for serialization to JSON.

Parameters:

errors - the errors to wrap

Returns:

a new Error list

wrapIfNecessary

public static List<MessageSourceResolvable> wrapIfNecessary(List<? extends MessageSourceResolvable> errors)

Wrap the given errors, if necessary, such that they are suitable for serialization to JSON. MessageSourceResolvable implementations that are known to be suitable are not wrapped.

Parameters:

errors - the errors to wrap

Returns:

a new Error list

Since:

3.5.4