/
ErrorAttributeOptions.java
142 lines (123 loc) · 4.02 KB
/
ErrorAttributeOptions.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/*
* Copyright 2012-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.boot.web.error;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.EnumSet;
import java.util.Set;
/**
* Options controlling the contents of {@code ErrorAttributes}.
*
* @author Scott Frederick
* @author Phillip Webb
* @author Wanderlei Souza
* @since 2.3.0
*/
public final class ErrorAttributeOptions {
private final Set<Include> includes;
private ErrorAttributeOptions(Set<Include> includes) {
this.includes = includes;
}
/**
* Get the option for including the specified attribute in the error response.
* @param include error attribute to get
* @return {@code true} if the {@code Include} attribute is included in the error
* response, {@code false} otherwise
*/
public boolean isIncluded(Include include) {
return this.includes.contains(include);
}
/**
* Get all options for including attributes in the error response.
* @return {@code true} if the {@code Include} attribute is included in the error
* response, {@code false} otherwise
*/
public Set<Include> getIncludes() {
return this.includes;
}
/**
* Return an {@code ErrorAttributeOptions} that includes the specified attribute
* {@link Include} options.
* @param includes error attributes to include
* @return an {@code ErrorAttributeOptions}
*/
public ErrorAttributeOptions including(Include... includes) {
EnumSet<Include> updated = (this.includes.isEmpty()) ? EnumSet.noneOf(Include.class)
: EnumSet.copyOf(this.includes);
updated.addAll(Arrays.asList(includes));
return new ErrorAttributeOptions(Collections.unmodifiableSet(updated));
}
/**
* Return an {@code ErrorAttributeOptions} that excludes the specified attribute
* {@link Include} options.
* @param excludes error attributes to exclude
* @return an {@code ErrorAttributeOptions}
*/
public ErrorAttributeOptions excluding(Include... excludes) {
EnumSet<Include> updated = (this.includes.isEmpty()) ? EnumSet.noneOf(Include.class)
: EnumSet.copyOf(this.includes);
updated.removeAll(Arrays.asList(excludes));
return new ErrorAttributeOptions(Collections.unmodifiableSet(updated));
}
/**
* Create an {@code ErrorAttributeOptions} with defaults.
* @return an {@code ErrorAttributeOptions}
*/
public static ErrorAttributeOptions defaults() {
return of();
}
/**
* Create an {@code ErrorAttributeOptions} that includes the specified attribute
* {@link Include} options.
* @param includes error attributes to include
* @return an {@code ErrorAttributeOptions}
*/
public static ErrorAttributeOptions of(Include... includes) {
return of(Arrays.asList(includes));
}
/**
* Create an {@code ErrorAttributeOptions} that includes the specified attribute
* {@link Include} options.
* @param includes error attributes to include
* @return an {@code ErrorAttributeOptions}
*/
public static ErrorAttributeOptions of(Collection<Include> includes) {
return new ErrorAttributeOptions(
(includes.isEmpty()) ? Collections.emptySet() : Collections.unmodifiableSet(EnumSet.copyOf(includes)));
}
/**
* Error attributes that can be included in an error response.
*/
public enum Include {
/**
* Include the exception class name attribute.
*/
EXCEPTION,
/**
* Include the stack trace attribute.
*/
STACK_TRACE,
/**
* Include the message attribute.
*/
MESSAGE,
/**
* Include the binding errors attribute.
*/
BINDING_ERRORS
}
}