Package org.springframework.boot.web.error

Enum Class ErrorAttributeOptions.Include

java.lang.Object

java.lang.Enum<ErrorAttributeOptions.Include>

org.springframework.boot.web.error.ErrorAttributeOptions.Include

All Implemented Interfaces:

Serializable, Comparable<ErrorAttributeOptions.Include>, Constable

Enclosing class:

ErrorAttributeOptions

public static enum ErrorAttributeOptions.Include
extends Enum<ErrorAttributeOptions.Include>

Error attributes that can be included in an error response.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BINDING_ERRORS	Include the binding errors attribute.
ERROR	Include the HTTP status code.
EXCEPTION	Include the exception class name attribute.
MESSAGE	Include the message attribute.
PATH	Include the request path.
STACK_TRACE	Include the stack trace attribute.
STATUS	Include the HTTP status code.

Method Summary

Modifier and Type	Method	Description
static ErrorAttributeOptions.Include	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ErrorAttributeOptions.Include[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EXCEPTION

public static final ErrorAttributeOptions.Include EXCEPTION

Include the exception class name attribute.

STACK_TRACE

public static final ErrorAttributeOptions.Include STACK_TRACE

Include the stack trace attribute.

MESSAGE

public static final ErrorAttributeOptions.Include MESSAGE

Include the message attribute.

BINDING_ERRORS

public static final ErrorAttributeOptions.Include BINDING_ERRORS

Include the binding errors attribute.

STATUS

public static final ErrorAttributeOptions.Include STATUS

Include the HTTP status code.

Since:

3.2.7

ERROR

public static final ErrorAttributeOptions.Include ERROR

Include the HTTP status code.

Since:

3.2.7

PATH

public static final ErrorAttributeOptions.Include PATH

Include the request path.

Since:

3.3.0

Method Details

values

public static ErrorAttributeOptions.Include[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ErrorAttributeOptions.Include valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null