Package org.springframework.boot.web.error

Class ErrorAttributeOptions

java.lang.Object

org.springframework.boot.web.error.ErrorAttributeOptions

public final class ErrorAttributeOptions
extends Object

Options controlling the contents of ErrorAttributes.

Since:

2.3.0

Author:

Scott Frederick, Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ErrorAttributeOptions.Include	Error attributes that can be included in an error response.

Method Summary

Modifier and Type	Method	Description
static ErrorAttributeOptions	defaults()	Create an ErrorAttributeOptions with defaults.
ErrorAttributeOptions	excluding(ErrorAttributeOptions.Include... excludes)	Return an ErrorAttributeOptions that excludes the specified attribute ErrorAttributeOptions.Include options.
Set<ErrorAttributeOptions.Include>	getIncludes()	Get all options for including attributes in the error response.
ErrorAttributeOptions	including(ErrorAttributeOptions.Include... includes)	Return an ErrorAttributeOptions that includes the specified attribute ErrorAttributeOptions.Include options.
boolean	isIncluded(ErrorAttributeOptions.Include include)	Get the option for including the specified attribute in the error response.
static ErrorAttributeOptions	of(Collection<ErrorAttributeOptions.Include> includes)	Create an ErrorAttributeOptions that includes the specified attribute ErrorAttributeOptions.Include options.
static ErrorAttributeOptions	of(ErrorAttributeOptions.Include... includes)	Create an ErrorAttributeOptions that includes the specified attribute ErrorAttributeOptions.Include options.
void	retainIncluded(Map<String,Object> map)	Remove elements from the given map if they are not included in this set of options.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

isIncluded

public boolean isIncluded(ErrorAttributeOptions.Include include)

Get the option for including the specified attribute in the error response.

Parameters:

include - error attribute to get

Returns:

true if the Include attribute is included in the error response, false otherwise

getIncludes

public Set<ErrorAttributeOptions.Include> getIncludes()

Get all options for including attributes in the error response.

Returns:

the options

including

public ErrorAttributeOptions including(ErrorAttributeOptions.Include... includes)

Return an ErrorAttributeOptions that includes the specified attribute ErrorAttributeOptions.Include options.

Parameters:

includes - error attributes to include

Returns:

an ErrorAttributeOptions

excluding

public ErrorAttributeOptions excluding(ErrorAttributeOptions.Include... excludes)

Return an ErrorAttributeOptions that excludes the specified attribute ErrorAttributeOptions.Include options.

Parameters:

excludes - error attributes to exclude

Returns:

an ErrorAttributeOptions

retainIncluded

public void retainIncluded(Map<String,Object> map)

Remove elements from the given map if they are not included in this set of options.

Parameters:

map - the map to update

Since:

3.2.7

defaults

public static ErrorAttributeOptions defaults()

Create an ErrorAttributeOptions with defaults.

Returns:

an ErrorAttributeOptions

of

public static ErrorAttributeOptions of(ErrorAttributeOptions.Include... includes)

Create an ErrorAttributeOptions that includes the specified attribute ErrorAttributeOptions.Include options.

Parameters:

includes - error attributes to include

Returns:

an ErrorAttributeOptions

of

public static ErrorAttributeOptions of(Collection<ErrorAttributeOptions.Include> includes)

Create an ErrorAttributeOptions that includes the specified attribute ErrorAttributeOptions.Include options.

Parameters:

includes - error attributes to include

Returns:

an ErrorAttributeOptions