ErrorAttributeOptions (spring-boot 2.5.11)

java.lang.Object
- org.springframework.boot.web.error.ErrorAttributeOptions

public final class ErrorAttributeOptions
extends java.lang.Object

Options controlling the contents of ErrorAttributes.

Since:: 2.3.0

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ErrorAttributeOptions.Include
Error attributes that can be included in an error response.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ErrorAttributeOptions.Include` Error attributes that can be included in an error response.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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.
`java.util.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(java.util.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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - 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 java.util.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
  - 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(java.util.Collection<ErrorAttributeOptions.Include> includes)
```
    Create an ErrorAttributeOptions that includes the specified attribute ErrorAttributeOptions.Include options.
    
    Parameters:
    
    includes - error attributes to include
    
    Returns:
    
    an ErrorAttributeOptions

Class ErrorAttributeOptions

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isIncluded

getIncludes

including

excluding

defaults

of

of