Class ErrorAttributeOptions
java.lang.Object
org.springframework.boot.web.error.ErrorAttributeOptions
Options controlling the contents of
ErrorAttributes.- Since:
- 2.3.0
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumError attributes that can be included in an error response. -
Method Summary
Modifier and TypeMethodDescriptionstatic ErrorAttributeOptionsdefaults()Create anErrorAttributeOptionswith defaults.excluding(ErrorAttributeOptions.Include... excludes) Return anErrorAttributeOptionsthat excludes the specified attributeErrorAttributeOptions.Includeoptions.Get all options for including attributes in the error response.including(ErrorAttributeOptions.Include... includes) Return anErrorAttributeOptionsthat includes the specified attributeErrorAttributeOptions.Includeoptions.booleanisIncluded(ErrorAttributeOptions.Include include) Get the option for including the specified attribute in the error response.static ErrorAttributeOptionsof(Collection<ErrorAttributeOptions.Include> includes) Create anErrorAttributeOptionsthat includes the specified attributeErrorAttributeOptions.Includeoptions.static ErrorAttributeOptionsof(ErrorAttributeOptions.Include... includes) Create anErrorAttributeOptionsthat includes the specified attributeErrorAttributeOptions.Includeoptions.
-
Method Details
-
isIncluded
Get the option for including the specified attribute in the error response.- Parameters:
include- error attribute to get- Returns:
trueif theIncludeattribute is included in the error response,falseotherwise
-
getIncludes
Get all options for including attributes in the error response.- Returns:
- the options
-
including
Return anErrorAttributeOptionsthat includes the specified attributeErrorAttributeOptions.Includeoptions.- Parameters:
includes- error attributes to include- Returns:
- an
ErrorAttributeOptions
-
excluding
Return anErrorAttributeOptionsthat excludes the specified attributeErrorAttributeOptions.Includeoptions.- Parameters:
excludes- error attributes to exclude- Returns:
- an
ErrorAttributeOptions
-
defaults
Create anErrorAttributeOptionswith defaults.- Returns:
- an
ErrorAttributeOptions
-
of
Create anErrorAttributeOptionsthat includes the specified attributeErrorAttributeOptions.Includeoptions.- Parameters:
includes- error attributes to include- Returns:
- an
ErrorAttributeOptions
-
of
Create anErrorAttributeOptionsthat includes the specified attributeErrorAttributeOptions.Includeoptions.- Parameters:
includes- error attributes to include- Returns:
- an
ErrorAttributeOptions
-